67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
---
|
|
name: collaborations-routes
|
|
description: Handle 5 OpenAPI operation(s) under /collaborations for the collaborations route group.
|
|
---
|
|
|
|
# collaborations API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /collaborations for the collaborations 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
|
|
|
|
### get_collaborations_id
|
|
|
|
- Operation ID: `get_collaborations_id`
|
|
- Route: `GET /collaborations/{collaboration_id}`
|
|
- Mode: READ
|
|
- Summary: Get collaboration
|
|
- Parameters:
|
|
- `collaboration_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### put_collaborations_id
|
|
|
|
- Operation ID: `put_collaborations_id`
|
|
- Route: `PUT /collaborations/{collaboration_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update collaboration
|
|
- Parameters:
|
|
- `collaboration_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_collaborations_id
|
|
|
|
- Operation ID: `delete_collaborations_id`
|
|
- Route: `DELETE /collaborations/{collaboration_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove collaboration
|
|
- Parameters:
|
|
- `collaboration_id` in `path` required
|
|
|
|
### get_collaborations
|
|
|
|
- Operation ID: `get_collaborations`
|
|
- Route: `GET /collaborations`
|
|
- Mode: READ
|
|
- Summary: List pending collaborations
|
|
- Parameters:
|
|
- `status` in `query` required
|
|
- `fields` in `query`
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
|
|
### post_collaborations
|
|
|
|
- Operation ID: `post_collaborations`
|
|
- Route: `POST /collaborations`
|
|
- Mode: WRITE
|
|
- Summary: Create collaboration
|
|
- Parameters:
|
|
- `fields` in `query`
|
|
- `notify` in `query`
|
|
- Body: JSON request body accepted.
|