synced/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2025-04-17 19:37:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2481 from Infisical/doc/add-groups-endpoints-to-api-reference

Browse Source 
doc: add groups endpoints to api reference documentation
This commit is contained in:
Maidul Islam
2024-09-25 09:50:40 -04:00
committed by GitHub
parent 095883a94e 3e3f42a8f7
commit a1f2629366
16 changed files with 79 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
backend/src/ee/routes/v1/group-router.ts
View File

@ -48,7 +48,7 @@ export const registerGroupRouter = async (server: FastifyZodProvider) => {
onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
schema: {
params: z.object({
id: z.string()
id: z.string().trim().describe(GROUPS.GET_BY_ID.id)
}),
response: {
200: GroupsSchema

3
backend/src/lib/api-docs/constants.ts
View File

@ -24,6 +24,9 @@ export const GROUPS = {
id: "The id of the group to add the user to.",
username: "The username of the user to add to the group."
},
GET_BY_ID: {
id: "The id of the group to fetch"
},
DELETE_USER: {
id: "The id of the group to remove the user from.",
username: "The username of the user to remove from the group."

4
docs/api-reference/endpoints/groups/add-group-user.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Add Group User"
openapi: "POST /api/v1/groups/{id}/users/{username}"
---

4
docs/api-reference/endpoints/groups/create.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/groups"
---

4
docs/api-reference/endpoints/groups/delete.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/groups/{id}"
---

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

@ -0,0 +1,4 @@
---
title: "Get By ID"
openapi: "GET /api/v1/groups/{id}"
---

4
docs/api-reference/endpoints/groups/get.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Get Groups in Organization"
openapi: "GET /api/v1/groups"
---

4
docs/api-reference/endpoints/groups/list-group-users.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "List Group Users"
openapi: "GET /api/v1/groups/{id}/users"
---

4
docs/api-reference/endpoints/groups/remove-group-user.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Remove Group User"
openapi: "DELETE /api/v1/groups/{id}/users/{username}"
---

4
docs/api-reference/endpoints/groups/update.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/groups/{id}"
---

4
docs/api-reference/endpoints/project-groups/create.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: "Create Project Membership"
openapi: "POST /api/v2/workspace/{projectId}/groups/{groupId}"
---

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

@ -0,0 +1,4 @@
---
title: "Delete Project Membership"
openapi: "DELETE /api/v2/workspace/{projectId}/groups/{groupId}"
---

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

@ -0,0 +1,4 @@
---
title: "Get Project Membership"
openapi: "GET /api/v2/workspace/{projectId}/groups/{groupId}"
---

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

@ -0,0 +1,4 @@
---
title: "List Project Memberships"
openapi: "GET /api/v2/workspace/{projectId}/groups"
---

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

@ -0,0 +1,4 @@
---
title: "Update Project Membership"
openapi: "PATCH /api/v2/workspace/{projectId}/groups/{groupId}"
---

23
docs/mint.json
View File

@ -546,6 +546,19 @@
"api-reference/endpoints/oidc-auth/revoke"
]
},
{
"group": "Groups",
"pages": [
"api-reference/endpoints/groups/create",
"api-reference/endpoints/groups/update",
"api-reference/endpoints/groups/delete",
"api-reference/endpoints/groups/get",
"api-reference/endpoints/groups/get-by-id",
"api-reference/endpoints/groups/add-group-user",
"api-reference/endpoints/groups/remove-group-user",
"api-reference/endpoints/groups/list-group-users"
]
},
{
"group": "Organizations",
"pages": [
@ -577,6 +590,16 @@
"api-reference/endpoints/project-users/update-membership"
]
},
{
"group": "Project Groups",
"pages": [
"api-reference/endpoints/project-groups/create",
"api-reference/endpoints/project-groups/delete",
"api-reference/endpoints/project-groups/get-by-id",
"api-reference/endpoints/project-groups/list",
"api-reference/endpoints/project-groups/update"
]
},
{
"group": "Project Identities",
"pages": [