From 97b2c534a7378c15f28fbc2b4c807dfd2ccce750 Mon Sep 17 00:00:00 2001 From: = Date: Wed, 13 Aug 2025 02:27:12 +0530 Subject: [PATCH] feat: added api document for project router get id from slug --- backend/src/server/routes/v2/project-router.ts | 2 ++ .../endpoints/workspaces/get-workspace-by-slug.mdx | 4 ++++ docs/docs.json | 1 + 3 files changed, 7 insertions(+) create mode 100644 docs/api-reference/endpoints/workspaces/get-workspace-by-slug.mdx diff --git a/backend/src/server/routes/v2/project-router.ts b/backend/src/server/routes/v2/project-router.ts index b71a744fd..37d1efee6 100644 --- a/backend/src/server/routes/v2/project-router.ts +++ b/backend/src/server/routes/v2/project-router.ts @@ -283,6 +283,8 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => { rateLimit: readLimit }, schema: { + hide: false, + tags: [ApiDocsTags.Projects], params: z.object({ slug: slugSchema({ max: 36 }).describe("The slug of the project to get.") }), diff --git a/docs/api-reference/endpoints/workspaces/get-workspace-by-slug.mdx b/docs/api-reference/endpoints/workspaces/get-workspace-by-slug.mdx new file mode 100644 index 000000000..944f61402 --- /dev/null +++ b/docs/api-reference/endpoints/workspaces/get-workspace-by-slug.mdx @@ -0,0 +1,4 @@ +--- +title: "Get Project Details By Slug" +openapi: "GET /api/v2/workspace/{slug}" +--- diff --git a/docs/docs.json b/docs/docs.json index 02cfd236a..922e80d32 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -995,6 +995,7 @@ { "group": "Projects", "pages": [ + "api-reference/endpoints/workspaces/get-workspace-by-slug", "api-reference/endpoints/workspaces/create-workspace", "api-reference/endpoints/workspaces/delete-workspace", "api-reference/endpoints/workspaces/get-workspace",