Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: revised note on accessing User and Workspace Management APIs #273

Merged
merged 2 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 | `<base-url>/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 | `<base-url>/v1/infra/users/{uid}/workspaces` |

<Info> To view the User Management API specifications, please visit our **[Swagger Documentation](https://stage-shc.hoppscotch.io/backend/api-docs)**. </Info>
<Info> 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). </Info>

### InfraTokens

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 | `<base-url>/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 | `<base-url>/v1/infra/users/{uid}/workspaces` |

<Info> To view the User Management API specifications, please visit our **[Swagger Documentation](https://stage-she.hoppscotch.io/backend/api-docs)**. </Info>
<Info> 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). </Info>

### Infra-tokens

Expand Down Expand Up @@ -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 | `<base-url>/v1/infra/workspaces/{id}/ invitations` |
| Delete pending workspace invites. | Revoke Workspace invitations using invitation IDs. | DELETE | `<base-url>/v1/infra/workspaces/{id}/ invitations/{invitation_id}` |

<Info> To know more about the Workspace Management API specifications, please visit our **[Swagger Documentation](https://stage-she.hoppscotch.io/backend/api-docs)**. </Info>
<Info> 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). </Info>

## Server Settings

Expand Down