Skip to content

improvement(api): centralize remaining v2 resource operations#6412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheodoreSpeaks merged 2 commits into from
Aug 8, 2026
Merged

improvement(api): centralize remaining v2 resource operations #6412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51dec53
improvement(api): centralize v2 resource operations
TheodoreSpeaks Aug 8, 2026
58419aa
fix(api): preserve custom tool conflict errors
TheodoreSpeaks Aug 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
393 changes: 124 additions & 269 deletions apps/sim/app/api/v2/custom-tools/[id]/route.test.ts
View file
Open in desktop

Large diffs are not rendered by default.

158 changes: 45 additions & 113 deletions apps/sim/app/api/v2/custom-tools/[id]/route.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,65 @@
import { AuditAction, AuditResourceType, recordAudit } from '@sim/audit'
import {
v2DeleteCustomToolContract,
v2GetCustomToolContract,
v2UpdateCustomToolContract,
} from '@/lib/api/contracts/v2/custom-tools'
import {
deleteWorkspaceCustomTool,
getWorkspaceCustomTool,
getWorkspaceCustomToolByTitle,
updateWorkspaceCustomTool,
} from '@/lib/workflows/custom-tools/operations'
import { withPublicApiRouteHandler } from '@/app/api/public-api-route-handler'
import { resolveWorkspaceAccess } from '@/app/api/v1/middleware'
import { toV2CustomTool, v2CustomToolWriteError } from '@/app/api/v2/custom-tools/utils'
import { v2Data, v2Error, v2WorkspaceAccessError } from '@/app/api/v2/lib/response'
defineV2JsonRoute,
v2ApiKeyAuth,
v2OrchestrationErrorPolicy,
v2RateLimits,
} from '@/lib/api/server/routes'
import { customToolOperations } from '@/lib/custom-tools/application/operations'
import {
deleteWorkspaceCustomToolUseCase,
getWorkspaceCustomToolUseCase,
updateWorkspaceCustomToolUseCase,
} from '@/lib/custom-tools/application/use-cases'
import { toV2CustomTool } from '@/app/api/v2/custom-tools/utils'

export const dynamic = 'force-dynamic'
export const revalidate = 0

interface RouteContext {
params: Promise<{ id: string }>
}

/** GET /api/v2/custom-tools/[id] — Fetch a single custom tool. */
export const GET = withPublicApiRouteHandler({
export const GET = defineV2JsonRoute({
contract: v2GetCustomToolContract,
rateLimitEndpoint: 'custom-tool-detail',
handler: async ({ input, auth: { userId, rateLimit } }) => {
const { id } = input.params
const { workspaceId } = input.query

const access = await resolveWorkspaceAccess(rateLimit, userId, workspaceId, 'read')
if (access) return v2WorkspaceAccessError(access)

const tool = await getWorkspaceCustomTool({ workspaceId, toolId: id })
if (!tool) return v2Error('NOT_FOUND', 'Custom tool not found')

return v2Data({ customTool: toV2CustomTool(tool) }, { rateLimit })
},
operation: customToolOperations.read,
auth: v2ApiKeyAuth,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
mapInput: ({ params, query }) => ({ workspaceId: query.workspaceId, toolId: params.id }),
useCase: getWorkspaceCustomToolUseCase,
present: ({ tool }) => ({ data: { customTool: toV2CustomTool(tool) } }),
})

/** PATCH /api/v2/custom-tools/[id] — Update a custom tool. Omitted fields keep their values. */
export const PATCH = withPublicApiRouteHandler({
/** PATCH /api/v2/custom-tools/[id] — Update a custom tool. */
export const PATCH = defineV2JsonRoute({
contract: v2UpdateCustomToolContract,
rateLimitEndpoint: 'custom-tool-detail',
handler: async ({ request, input, auth: { userId, rateLimit } }) => {
try {
const { id } = input.params
const { workspaceId, title, schema, code } = input.body

const access = await resolveWorkspaceAccess(rateLimit, userId, workspaceId, 'write')
if (access) return v2WorkspaceAccessError(access)

const current = await getWorkspaceCustomTool({ workspaceId, toolId: id })
if (!current) return v2Error('NOT_FOUND', 'Custom tool not found')

/**
* `upsertCustomTools` replaces title/schema/code wholesale and checks for a
* duplicate title only when inserting, so a rename onto an existing title
* would hit the `custom_tools_workspace_title_unique` index as a 500. Merge
* the partial body against the stored row and check the rename here.
*/
if (title !== undefined && title !== current.title) {
if (await getWorkspaceCustomToolByTitle({ workspaceId, title })) {
return v2Error(
'CONFLICT',
`A custom tool titled "${title}" already exists in this workspace`
)
}
}

const updated = await updateWorkspaceCustomTool({
workspaceId,
toolId: id,
title: title ?? current.title,
schema: schema ?? current.schema,
code: code ?? current.code,
})
if (!updated) return v2Error('NOT_FOUND', 'Custom tool not found')

recordAudit({
workspaceId,
actorId: userId,
action: AuditAction.CUSTOM_TOOL_UPDATED,
resourceType: AuditResourceType.CUSTOM_TOOL,
resourceId: updated.id,
resourceName: updated.title,
description: `Updated custom tool "${updated.title}" via API`,
request,
})

return v2Data({ customTool: toV2CustomTool(updated) }, { rateLimit })
} catch (error) {
const writeError = v2CustomToolWriteError(error)
if (writeError) return writeError

throw error
}
},
operation: customToolOperations.update,
auth: v2ApiKeyAuth,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
mapInput: ({ params, body }) => ({
...body,
toolId: params.id,
source: 'api' as const,
}),
useCase: updateWorkspaceCustomToolUseCase,
present: ({ tool }) => ({ data: { customTool: toV2CustomTool(tool) } }),
})

/** DELETE /api/v2/custom-tools/[id] — Delete a custom tool. */
export const DELETE = withPublicApiRouteHandler({
export const DELETE = defineV2JsonRoute({
contract: v2DeleteCustomToolContract,
rateLimitEndpoint: 'custom-tool-detail',
handler: async ({ request, input, auth: { userId, rateLimit } }) => {
const { id } = input.params
const { workspaceId } = input.query

const access = await resolveWorkspaceAccess(rateLimit, userId, workspaceId, 'write')
if (access) return v2WorkspaceAccessError(access)

const tool = await getWorkspaceCustomTool({ workspaceId, toolId: id })
if (!tool) return v2Error('NOT_FOUND', 'Custom tool not found')

const deleted = await deleteWorkspaceCustomTool({ workspaceId, toolId: id })
if (!deleted) return v2Error('NOT_FOUND', 'Custom tool not found')

recordAudit({
workspaceId,
actorId: userId,
action: AuditAction.CUSTOM_TOOL_DELETED,
resourceType: AuditResourceType.CUSTOM_TOOL,
resourceId: id,
resourceName: tool.title,
description: `Deleted custom tool "${tool.title}" via API`,
request,
})

return v2Data({ id, deleted: true as const }, { rateLimit })
},
operation: customToolOperations.delete,
auth: v2ApiKeyAuth,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
mapInput: ({ params, query }) => ({
workspaceId: query.workspaceId,
toolId: params.id,
source: 'api' as const,
}),
useCase: deleteWorkspaceCustomToolUseCase,
present: ({ tool }) => ({ data: { id: tool.id, deleted: true as const } }),
})
Loading
Loading