diff --git a/documentation/self-host/community-edition/admin-dashboard.mdx b/documentation/self-host/community-edition/admin-dashboard.mdx index 46cf6f86..eaa4aa25 100644 --- a/documentation/self-host/community-edition/admin-dashboard.mdx +++ b/documentation/self-host/community-edition/admin-dashboard.mdx @@ -76,7 +76,7 @@ The RESTful APIs designed for User Management enable **admins** to perform a wid | Manage Admin Status | Enables admins to add or remove admin status for an existing user. | PATCH | `/v1/infra/users/{uid}/admin-status` | | Fetch User’s involvement in Workspaces | Retrieves workspace details that a user is part of, including their role. | GET | `/v1/infra/users/{uid}/workspaces` | - To view the User Management API specifications, please visit our **[Swagger Documentation](https://stage-shc.hoppscotch.io/backend/api-docs)**. + To interact with the **User Management APIs**, ensure that your backend service is running, either on your local machine or on a server. The API documentation is accessible at the `/api-docs` endpoint relative to your backend service URL. For example, if your backend is running locally, you can access the API docs at [http://localhost:3170/api-docs](http://localhost:3170/api-docs). You can also retrieve the OpenAPI v3 JSON format at [http://localhost:3170/api-docs-json](http://localhost:3170/api-docs-json). ### InfraTokens diff --git a/documentation/self-host/enterprise-edition/admin-dashboard.mdx b/documentation/self-host/enterprise-edition/admin-dashboard.mdx index 23724679..5258fce2 100644 --- a/documentation/self-host/enterprise-edition/admin-dashboard.mdx +++ b/documentation/self-host/enterprise-edition/admin-dashboard.mdx @@ -76,7 +76,7 @@ The RESTful APIs designed for User Management enable **admins** to perform a wid | Manage Admin Status | Enables admins to add or remove admin status for an existing user. | PATCH | `/v1/infra/users/{uid}/admin-status` | | Fetch User’s involvement in Workspaces | Retrieves workspace details that a user is part of, including their role. | GET | `/v1/infra/users/{uid}/workspaces` | - To view the User Management API specifications, please visit our **[Swagger Documentation](https://stage-she.hoppscotch.io/backend/api-docs)**. + To interact with the **User Management APIs**, ensure that your backend service is running, either on your local machine or on a server. The API documentation is accessible at the `/api-docs` endpoint relative to your backend service URL. For example, if your backend is running locally, you can access the API docs at [http://localhost:3170/api-docs](http://localhost:3170/api-docs). You can also retrieve the OpenAPI v3 JSON format at [http://localhost:3170/api-docs-json](http://localhost:3170/api-docs-json). ### Infra-tokens @@ -131,7 +131,7 @@ We’ve introduced new **APIs** to make **workspace management** and **collabora | View all pending workspace invites. | List all pending invites for workspace access. | GET | `/v1/infra/workspaces/{id}/ invitations` | | Delete pending workspace invites. | Revoke Workspace invitations using invitation IDs. | DELETE | `/v1/infra/workspaces/{id}/ invitations/{invitation_id}` | - To know more about the Workspace Management API specifications, please visit our **[Swagger Documentation](https://stage-she.hoppscotch.io/backend/api-docs)**. + To interact with the **Workspace Management APIs**, ensure that your backend service is running, either on your local machine or on a server. The API documentation is accessible at the `/api-docs` endpoint relative to your backend service URL. For example, if your backend is running locally, you can access the API docs at [http://localhost:3170/api-docs](http://localhost:3170/api-docs). You can also retrieve the OpenAPI v3 JSON format at [http://localhost:3170/api-docs-json](http://localhost:3170/api-docs-json). ## Server Settings