From ce4cb39a2da01d2b27417a351c28bba7e62e848c Mon Sep 17 00:00:00 2001 From: = Date: Fri, 17 May 2024 20:49:58 +0530 Subject: [PATCH] docs: added doc for new endpoints of getting membership and some title change --- .../endpoints/project-identities/add-identity-membership.mdx | 2 +- .../project-identities/delete-identity-membership.mdx | 2 +- docs/api-reference/endpoints/project-identities/get-by-id.mdx | 4 ++++ .../project-identities/list-identity-memberships.mdx | 2 +- .../project-identities/update-identity-membership.mdx | 2 +- .../api-reference/endpoints/project-users/get-by-username.mdx | 4 ++++ .../endpoints/project-users/invite-member-to-workspace.mdx | 2 +- docs/mint.json | 4 +++- 8 files changed, 16 insertions(+), 6 deletions(-) create mode 100644 docs/api-reference/endpoints/project-identities/get-by-id.mdx create mode 100644 docs/api-reference/endpoints/project-users/get-by-username.mdx diff --git a/docs/api-reference/endpoints/project-identities/add-identity-membership.mdx b/docs/api-reference/endpoints/project-identities/add-identity-membership.mdx index 391e4b1c3..285b1d1c4 100644 --- a/docs/api-reference/endpoints/project-identities/add-identity-membership.mdx +++ b/docs/api-reference/endpoints/project-identities/add-identity-membership.mdx @@ -1,4 +1,4 @@ --- -title: "Add Identity Project Membership" +title: "Create Identity Membership" openapi: "POST /api/v2/workspace/{projectId}/identity-memberships/{identityId}" --- diff --git a/docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx b/docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx index ba04ca884..e2b266626 100644 --- a/docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx +++ b/docs/api-reference/endpoints/project-identities/delete-identity-membership.mdx @@ -1,4 +1,4 @@ --- -title: "Delete Project Identity Membership" +title: "Delete Identity Membership" openapi: "DELETE /api/v2/workspace/{projectId}/identity-memberships/{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 new file mode 100644 index 000000000..04211e837 --- /dev/null +++ b/docs/api-reference/endpoints/project-identities/get-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Get By Identity Id" +openapi: "GET /api/v2/workspace/{projectId}/identity-memberships/{identityId}" +--- diff --git a/docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx b/docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx index aeadaa5f5..e5162e693 100644 --- a/docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx +++ b/docs/api-reference/endpoints/project-identities/list-identity-memberships.mdx @@ -1,4 +1,4 @@ --- -title: "List Project Identity Memberships" +title: "List Identity Memberships" openapi: "GET /api/v2/workspace/{projectId}/identity-memberships" --- diff --git a/docs/api-reference/endpoints/project-identities/update-identity-membership.mdx b/docs/api-reference/endpoints/project-identities/update-identity-membership.mdx index f77e05f0a..667cf7eb3 100644 --- a/docs/api-reference/endpoints/project-identities/update-identity-membership.mdx +++ b/docs/api-reference/endpoints/project-identities/update-identity-membership.mdx @@ -1,4 +1,4 @@ --- -title: "Update Project Identity Membership" +title: "Update Identity Membership" openapi: "PATCH /api/v2/workspace/{projectId}/identity-memberships/{identityId}" --- diff --git a/docs/api-reference/endpoints/project-users/get-by-username.mdx b/docs/api-reference/endpoints/project-users/get-by-username.mdx new file mode 100644 index 000000000..ec69d4947 --- /dev/null +++ b/docs/api-reference/endpoints/project-users/get-by-username.mdx @@ -0,0 +1,4 @@ +--- +title: "Get By Username" +openapi: "POST /api/v1/workspace/{workspaceId}/memberships/details" +--- diff --git a/docs/api-reference/endpoints/project-users/invite-member-to-workspace.mdx b/docs/api-reference/endpoints/project-users/invite-member-to-workspace.mdx index a09c586ca..28acd3336 100644 --- a/docs/api-reference/endpoints/project-users/invite-member-to-workspace.mdx +++ b/docs/api-reference/endpoints/project-users/invite-member-to-workspace.mdx @@ -1,4 +1,4 @@ --- title: "Invite Member" openapi: "POST /api/v2/workspace/{projectId}/memberships" ---- \ No newline at end of file +--- diff --git a/docs/mint.json b/docs/mint.json index 12d0b4978..7076e3ae9 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -1,6 +1,6 @@ { "name": "Infisical", - "openapi": "http://localhost:8080/api/docs/json", + "openapi": "https://app.infisical.com/api/docs/json", "logo": { "dark": "/logo/dark.svg", "light": "/logo/light.svg", @@ -459,6 +459,7 @@ "api-reference/endpoints/project-users/invite-member-to-workspace", "api-reference/endpoints/project-users/remove-member-from-workspace", "api-reference/endpoints/project-users/memberships", + "api-reference/endpoints/project-users/get-by-username", "api-reference/endpoints/project-users/update-membership" ] }, @@ -467,6 +468,7 @@ "pages": [ "api-reference/endpoints/project-identities/add-identity-membership", "api-reference/endpoints/project-identities/list-identity-memberships", + "api-reference/endpoints/project-identities/get-by-id", "api-reference/endpoints/project-identities/update-identity-membership", "api-reference/endpoints/project-identities/delete-identity-membership" ]