github/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2026-01-09 23:48:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: updated docs with new endpoints

Browse Source
This commit is contained in:
=
2025-11-11 16:17:14 +05:30
parent 5eb67aefae
commit 45b89f592e
17 changed files with 67 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
backend/src/server/routes/v1/project-identity-router.ts
View File

@@ -42,6 +42,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider)
}, },
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: { schema: {
hide: false,
tags: [ApiDocsTags.Identities], tags: [ApiDocsTags.Identities],
description: "Create an identity in a project", description: "Create an identity in a project",
security: [ security: [
@@ -104,6 +105,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider)
}, },
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: { schema: {
hide: false,
tags: [ApiDocsTags.Identities], tags: [ApiDocsTags.Identities],
description: "Update an identity in a project", description: "Update an identity in a project",
security: [ security: [
@@ -170,6 +172,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider)
}, },
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: { schema: {
hide: false,
tags: [ApiDocsTags.Identities], tags: [ApiDocsTags.Identities],
description: "Delete an identity from a project", description: "Delete an identity from a project",
security: [ security: [
@@ -223,6 +226,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider)
}, },
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: { schema: {
hide: false,
tags: [ApiDocsTags.Identities], tags: [ApiDocsTags.Identities],
description: "Get an identity by ID in a project", description: "Get an identity by ID in a project",
security: [ security: [
@@ -265,6 +269,7 @@ export const registerProjectIdentityRouter = async (server: FastifyZodProvider)
}, },
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]), onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: { schema: {
hide: false,
tags: [ApiDocsTags.Identities], tags: [ApiDocsTags.Identities],
description: "List identities in a project", description: "List identities in a project",
security: [ security: [

0
docs/api-reference/endpoints/project-identities/add-identity-membership.mdx → docs/api-reference/endpoints/deprecated/project-identities-v2/add-identity-membership.mdx
View File

0
docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx → docs/api-reference/endpoints/deprecated/project-identities-v2/delete-identity-membership.mdx
View File

4
docs/api-reference/endpoints/deprecated/project-identities-v2/get-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get Identity by ID"
openapi: "GET /api/v1/projects/{projectId}/identity-memberships/{identityId}"
---

0
docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx → docs/api-reference/endpoints/deprecated/project-identities-v2/list-identity-memberships.mdx
View File

0
docs/api-reference/endpoints/project-identities/update-identity-membership.mdx → docs/api-reference/endpoints/deprecated/project-identities-v2/update-identity-membership.mdx
View File

4
docs/api-reference/endpoints/project-identities-membership/add-identity-membership.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Create Identity Membership"
openapi: "POST /api/v1/projects/{projectId}/memberships/identities/{identityId}"
---

4
docs/api-reference/endpoints/project-identities-membership/delete-identity-membership.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete Identity Membership"
openapi: "DELETE /api/v1/projects/{projectId}/memberships/identities/{identityId}"
---

4
docs/api-reference/endpoints/project-identities-membership/get-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get Identity by ID"
openapi: "GET /api/v1/projects/{projectId}/memberships/identities/{identityId}"
---

4
docs/api-reference/endpoints/project-identities-membership/list-identity-memberships.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List Identity Memberships"
openapi: "GET /api/v1/projects/{projectId}/memberships/identities"
---

4
docs/api-reference/endpoints/project-identities-membership/update-identity-membership.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Update Identity Membership"
openapi: "PATCH /api/v1/projects/{projectId}/memberships/identities/{identityId}"
---

4
docs/api-reference/endpoints/project-identities/add-identity.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Create Identity"
openapi: "POST /api/v1/projects/{projectId}/identities"
---

4
docs/api-reference/endpoints/project-identities/delete-identity.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete Identity"
openapi: "DELETE /api/v1/projects/{projectId}/identities/{identityId}"
---

4
docs/api-reference/endpoints/project-identities/get-by-id.mdx
View File

@@ -1,4 +1,4 @@
--- ---
title: "Get Identity by ID" title: "Get Identity By Id"
openapi: "GET /api/v1/projects/{projectId}/identity-memberships/{identityId}" openapi: "GET /api/v1/projects/{projectId}/identities/{identityId}"
--- ---

4
docs/api-reference/endpoints/project-identities/list-identity.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List Identity"
openapi: "POST /api/v1/projects/{projectId}/identities"
---

4
docs/api-reference/endpoints/project-identities/update-identity.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Update Identity"
openapi: "PATCH /api/v1/projects/{projectId}/identities/{identityId}"
---

30
docs/docs.json
View File

@@ -1150,21 +1150,31 @@
] ]
}, },
{ {
"group": "Project Identities", "group": "Project Managed Identities",
"pages": [ "pages": [
"api-reference/endpoints/project-identities/add-identity-membership", "api-reference/endpoints/project-identities/add-identity",
"api-reference/endpoints/project-identities/list-identity-memberships", "api-reference/endpoints/project-identities/list-identity",
"api-reference/endpoints/project-identities/get-by-id", "api-reference/endpoints/project-identities/get-by-id",
"api-reference/endpoints/project-identities/update-identity-membership", "api-reference/endpoints/project-identities/update-identity",
"api-reference/endpoints/project-identities/delete-identity-membership", "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", "group": "Legacy",
"pages": [ "pages": [
"api-reference/endpoints/deprecated/project-identities/add-identity-membership", "api-reference/endpoints/deprecated/project-identities-v2/add-identity-membership",
"api-reference/endpoints/deprecated/project-identities/list-identity-memberships", "api-reference/endpoints/deprecated/project-identities-v2/list-identity-memberships",
"api-reference/endpoints/deprecated/project-identities/get-by-id", "api-reference/endpoints/deprecated/project-identities-v2/get-by-id",
"api-reference/endpoints/deprecated/project-identities/update-identity-membership", "api-reference/endpoints/deprecated/project-identities-v2/update-identity-membership",
"api-reference/endpoints/deprecated/project-identities/delete-identity-membership" "api-reference/endpoints/deprecated/project-identities-v2/delete-identity-membership"
] ]
} }
] ]