From 45b89f592e6e8b236036f6ba97aa9718d0a208c4 Mon Sep 17 00:00:00 2001 From: = Date: Tue, 11 Nov 2025 16:17:14 +0530 Subject: [PATCH] feat: updated docs with new endpoints --- .../routes/v1/project-identity-router.ts | 5 ++++ .../add-identity-membership.mdx | 0 .../delete-identity-membership.mdx | 0 .../project-identities-v2/get-by-id.mdx | 4 +++ .../list-identity-memberships.mdx | 0 .../update-identity-membership.mdx | 0 .../add-identity-membership.mdx | 4 +++ .../delete-identity-membership.mdx | 4 +++ .../get-by-id.mdx | 4 +++ .../list-identity-memberships.mdx | 4 +++ .../update-identity-membership.mdx | 4 +++ .../project-identities/add-identity.mdx | 4 +++ .../project-identities/delete-identity.mdx | 4 +++ .../project-identities/get-by-id.mdx | 4 +-- .../project-identities/list-identity.mdx | 4 +++ .../project-identities/update-identity.mdx | 4 +++ docs/docs.json | 30 ++++++++++++------- 17 files changed, 67 insertions(+), 12 deletions(-) rename docs/api-reference/endpoints/{project-identities => deprecated/project-identities-v2}/add-identity-membership.mdx (100%) rename docs/api-reference/endpoints/{project-identities => deprecated/project-identities-v2}/delete-identity-membership.mdx (100%) create mode 100644 docs/api-reference/endpoints/deprecated/project-identities-v2/get-by-id.mdx rename docs/api-reference/endpoints/{project-identities => deprecated/project-identities-v2}/list-identity-memberships.mdx (100%) rename docs/api-reference/endpoints/{project-identities => deprecated/project-identities-v2}/update-identity-membership.mdx (100%) create mode 100644 docs/api-reference/endpoints/project-identities-membership/add-identity-membership.mdx create mode 100644 docs/api-reference/endpoints/project-identities-membership/delete-identity-membership.mdx create mode 100644 docs/api-reference/endpoints/project-identities-membership/get-by-id.mdx create mode 100644 docs/api-reference/endpoints/project-identities-membership/list-identity-memberships.mdx create mode 100644 docs/api-reference/endpoints/project-identities-membership/update-identity-membership.mdx create mode 100644 docs/api-reference/endpoints/project-identities/add-identity.mdx create mode 100644 docs/api-reference/endpoints/project-identities/delete-identity.mdx create mode 100644 docs/api-reference/endpoints/project-identities/list-identity.mdx create mode 100644 docs/api-reference/endpoints/project-identities/update-identity.mdx diff --git a/backend/src/server/routes/v1/project-identity-router.ts b/backend/src/server/routes/v1/project-identity-router.ts index 9807dd20d3..0eabe0a13b 100644 --- a/backend/src/server/routes/v1/project-identity-router.ts +++ b/backend/src/server/routes/v1/project-identity-router.ts @@ -42,6 +42,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider) }, onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), schema: { + hide: false, tags: [ApiDocsTags.Identities], description: "Create an identity in a project", security: [ @@ -104,6 +105,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider) }, onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), schema: { + hide: false, tags: [ApiDocsTags.Identities], description: "Update an identity in a project", security: [ @@ -170,6 +172,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider) }, onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), schema: { + hide: false, tags: [ApiDocsTags.Identities], description: "Delete an identity from a project", security: [ @@ -223,6 +226,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider) }, onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), schema: { + hide: false, tags: [ApiDocsTags.Identities], description: "Get an identity by ID in a project", security: [ @@ -265,6 +269,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider) }, onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), schema: { + hide: false, tags: [ApiDocsTags.Identities], description: "List identities in a project", security: [ diff --git a/docs/api-reference/endpoints/project-identities/add-identity-membership.mdx b/docs/api-reference/endpoints/deprecated/project-identities-v2/add-identity-membership.mdx similarity index 100% rename from docs/api-reference/endpoints/project-identities/add-identity-membership.mdx rename to docs/api-reference/endpoints/deprecated/project-identities-v2/add-identity-membership.mdx diff --git a/docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx b/docs/api-reference/endpoints/deprecated/project-identities-v2/delete-identity-membership.mdx similarity index 100% rename from docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx rename to docs/api-reference/endpoints/deprecated/project-identities-v2/delete-identity-membership.mdx diff --git a/docs/api-reference/endpoints/deprecated/project-identities-v2/get-by-id.mdx b/docs/api-reference/endpoints/deprecated/project-identities-v2/get-by-id.mdx new file mode 100644 index 0000000000..801b0d422f --- /dev/null +++ b/docs/api-reference/endpoints/deprecated/project-identities-v2/get-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Get Identity by ID" +openapi: "GET /api/v1/projects/{projectId}/identity-memberships/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx b/docs/api-reference/endpoints/deprecated/project-identities-v2/list-identity-memberships.mdx similarity index 100% rename from docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx rename to docs/api-reference/endpoints/deprecated/project-identities-v2/list-identity-memberships.mdx diff --git a/docs/api-reference/endpoints/project-identities/update-identity-membership.mdx b/docs/api-reference/endpoints/deprecated/project-identities-v2/update-identity-membership.mdx similarity index 100% rename from docs/api-reference/endpoints/project-identities/update-identity-membership.mdx rename to docs/api-reference/endpoints/deprecated/project-identities-v2/update-identity-membership.mdx diff --git a/docs/api-reference/endpoints/project-identities-membership/add-identity-membership.mdx b/docs/api-reference/endpoints/project-identities-membership/add-identity-membership.mdx new file mode 100644 index 0000000000..0045887133 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities-membership/add-identity-membership.mdx @@ -0,0 +1,4 @@ +--- +title: "Create Identity Membership" +openapi: "POST /api/v1/projects/{projectId}/memberships/identities/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities-membership/delete-identity-membership.mdx b/docs/api-reference/endpoints/project-identities-membership/delete-identity-membership.mdx new file mode 100644 index 0000000000..c170dfecfa --- /dev/null +++ b/docs/api-reference/endpoints/project-identities-membership/delete-identity-membership.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete Identity Membership" +openapi: "DELETE /api/v1/projects/{projectId}/memberships/identities/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities-membership/get-by-id.mdx b/docs/api-reference/endpoints/project-identities-membership/get-by-id.mdx new file mode 100644 index 0000000000..69e0317d19 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities-membership/get-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Get Identity by ID" +openapi: "GET /api/v1/projects/{projectId}/memberships/identities/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities-membership/list-identity-memberships.mdx b/docs/api-reference/endpoints/project-identities-membership/list-identity-memberships.mdx new file mode 100644 index 0000000000..647f9f0326 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities-membership/list-identity-memberships.mdx @@ -0,0 +1,4 @@ +--- +title: "List Identity Memberships" +openapi: "GET /api/v1/projects/{projectId}/memberships/identities" +--- diff --git a/docs/api-reference/endpoints/project-identities-membership/update-identity-membership.mdx b/docs/api-reference/endpoints/project-identities-membership/update-identity-membership.mdx new file mode 100644 index 0000000000..3e8ddbf371 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities-membership/update-identity-membership.mdx @@ -0,0 +1,4 @@ +--- +title: "Update Identity Membership" +openapi: "PATCH /api/v1/projects/{projectId}/memberships/identities/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities/add-identity.mdx b/docs/api-reference/endpoints/project-identities/add-identity.mdx new file mode 100644 index 0000000000..a00d12c972 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities/add-identity.mdx @@ -0,0 +1,4 @@ +--- +title: "Create Identity" +openapi: "POST /api/v1/projects/{projectId}/identities" +--- diff --git a/docs/api-reference/endpoints/project-identities/delete-identity.mdx b/docs/api-reference/endpoints/project-identities/delete-identity.mdx new file mode 100644 index 0000000000..3c4ebfa043 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities/delete-identity.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete Identity" +openapi: "DELETE /api/v1/projects/{projectId}/identities/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities/get-by-id.mdx b/docs/api-reference/endpoints/project-identities/get-by-id.mdx index 801b0d422f..a1f8773144 100644 --- a/docs/api-reference/endpoints/project-identities/get-by-id.mdx +++ b/docs/api-reference/endpoints/project-identities/get-by-id.mdx @@ -1,4 +1,4 @@ --- -title: "Get Identity by ID" -openapi: "GET /api/v1/projects/{projectId}/identity-memberships/{identityId}" +title: "Get Identity By Id" +openapi: "GET /api/v1/projects/{projectId}/identities/{identityId}" --- diff --git a/docs/api-reference/endpoints/project-identities/list-identity.mdx b/docs/api-reference/endpoints/project-identities/list-identity.mdx new file mode 100644 index 0000000000..c6b1bc1e40 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities/list-identity.mdx @@ -0,0 +1,4 @@ +--- +title: "List Identity" +openapi: "POST /api/v1/projects/{projectId}/identities" +--- diff --git a/docs/api-reference/endpoints/project-identities/update-identity.mdx b/docs/api-reference/endpoints/project-identities/update-identity.mdx new file mode 100644 index 0000000000..683642a12c --- /dev/null +++ b/docs/api-reference/endpoints/project-identities/update-identity.mdx @@ -0,0 +1,4 @@ +--- +title: "Update Identity" +openapi: "PATCH /api/v1/projects/{projectId}/identities/{identityId}" +--- diff --git a/docs/docs.json b/docs/docs.json index 97d35e8e96..e57be9388f 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -1150,21 +1150,31 @@ ] }, { - "group": "Project Identities", + "group": "Project Managed Identities", "pages": [ - "api-reference/endpoints/project-identities/add-identity-membership", - "api-reference/endpoints/project-identities/list-identity-memberships", + "api-reference/endpoints/project-identities/add-identity", + "api-reference/endpoints/project-identities/list-identity", "api-reference/endpoints/project-identities/get-by-id", - "api-reference/endpoints/project-identities/update-identity-membership", - "api-reference/endpoints/project-identities/delete-identity-membership", + "api-reference/endpoints/project-identities/update-identity", + "api-reference/endpoints/project-identities/delete-identity" + ] + }, + { + "group": "Project Identity Memberships", + "pages": [ + "api-reference/endpoints/project-identities-membership/add-identity-membership", + "api-reference/endpoints/project-identities-membership/list-identity-memberships", + "api-reference/endpoints/project-identities-membership/get-by-id", + "api-reference/endpoints/project-identities-membership/update-identity-membership", + "api-reference/endpoints/project-identities-membership/delete-identity-membership", { "group": "Legacy", "pages": [ - "api-reference/endpoints/deprecated/project-identities/add-identity-membership", - "api-reference/endpoints/deprecated/project-identities/list-identity-memberships", - "api-reference/endpoints/deprecated/project-identities/get-by-id", - "api-reference/endpoints/deprecated/project-identities/update-identity-membership", - "api-reference/endpoints/deprecated/project-identities/delete-identity-membership" + "api-reference/endpoints/deprecated/project-identities-v2/add-identity-membership", + "api-reference/endpoints/deprecated/project-identities-v2/list-identity-memberships", + "api-reference/endpoints/deprecated/project-identities-v2/get-by-id", + "api-reference/endpoints/deprecated/project-identities-v2/update-identity-membership", + "api-reference/endpoints/deprecated/project-identities-v2/delete-identity-membership" ] } ]