diff --git a/backend/src/lib/api-docs/constants.ts b/backend/src/lib/api-docs/constants.ts index fd51119f1..e005aee4c 100644 --- a/backend/src/lib/api-docs/constants.ts +++ b/backend/src/lib/api-docs/constants.ts @@ -551,5 +551,8 @@ export const INTEGRATION = { }, DELETE: { integrationId: "The ID of the integration object." + }, + LIST_INTEGRATION: { + workspaceId: "The ID of the project to list integrations for." } }; diff --git a/backend/src/server/routes/v1/project-router.ts b/backend/src/server/routes/v1/project-router.ts index a4df0416e..3be0e886d 100644 --- a/backend/src/server/routes/v1/project-router.ts +++ b/backend/src/server/routes/v1/project-router.ts @@ -7,7 +7,7 @@ import { UserEncryptionKeysSchema, UsersSchema } from "@app/db/schemas"; -import { INTEGRATION_AUTH, PROJECTS } from "@app/lib/api-docs"; +import { INTEGRATION, INTEGRATION_AUTH, PROJECTS } from "@app/lib/api-docs"; import { readLimit, writeLimit } from "@app/server/config/rateLimiter"; import { verifyAuth } from "@app/server/plugins/auth/verify-auth"; import { AuthMode } from "@app/services/auth/auth-type"; @@ -326,8 +326,14 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => { rateLimit: readLimit }, schema: { + description: "List integrations for a project.", + security: [ + { + bearerAuth: [] + } + ], params: z.object({ - workspaceId: z.string().trim() + workspaceId: z.string().trim().describe(INTEGRATION.LIST_INTEGRATION.workspaceId) }), response: { 200: z.object({ diff --git a/docs/api-reference/endpoints/integrations/list-project-integrations.mdx b/docs/api-reference/endpoints/integrations/list-project-integrations.mdx new file mode 100644 index 000000000..ee652961c --- /dev/null +++ b/docs/api-reference/endpoints/integrations/list-project-integrations.mdx @@ -0,0 +1,4 @@ +--- +title: "List project integrations" +openapi: "GET /api/v1/workspace/{workspaceId}/integrations" +--- diff --git a/docs/mint.json b/docs/mint.json index 4ab246f83..47c8561ab 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -519,7 +519,8 @@ "api-reference/endpoints/integrations/delete-auth-by-id", "api-reference/endpoints/integrations/create", "api-reference/endpoints/integrations/update", - "api-reference/endpoints/integrations/delete" + "api-reference/endpoints/integrations/delete", + "api-reference/endpoints/integrations/list-project-integrations" ] }, {