62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
---
|
|
name: roles-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/v1/roles for the roles route group.
|
|
---
|
|
|
|
# roles API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/v1/roles for the roles route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### api_create_role_api_v1_roles_org_org_id_post
|
|
|
|
- Operation ID: `api_create_role_api_v1_roles_org_org_id_post`
|
|
- Route: `POST /api/v1/roles/org/{org_id}`
|
|
- Mode: WRITE
|
|
- Summary: Create role
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_roles_by_organization_api_v1_roles_org_org_id_get
|
|
|
|
- Operation ID: `api_get_roles_by_organization_api_v1_roles_org_org_id_get`
|
|
- Route: `GET /api/v1/roles/org/{org_id}`
|
|
- Mode: READ
|
|
- Summary: List roles for organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
|
|
### api_get_role_api_v1_roles_role_id_get
|
|
|
|
- Operation ID: `api_get_role_api_v1_roles_role_id_get`
|
|
- Route: `GET /api/v1/roles/{role_id}`
|
|
- Mode: READ
|
|
- Summary: Get role
|
|
- Parameters:
|
|
- `role_id` in `path` required
|
|
|
|
### api_update_role_api_v1_roles_role_id_put
|
|
|
|
- Operation ID: `api_update_role_api_v1_roles_role_id_put`
|
|
- Route: `PUT /api/v1/roles/{role_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update role
|
|
- Parameters:
|
|
- `role_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_role_api_v1_roles_role_id_delete
|
|
|
|
- Operation ID: `api_delete_role_api_v1_roles_role_id_delete`
|
|
- Route: `DELETE /api/v1/roles/{role_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete role
|
|
- Parameters:
|
|
- `role_id` in `path` required
|