62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
---
|
|
name: collections-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/v1/collections for the collections route group.
|
|
---
|
|
|
|
# collections API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/v1/collections for the collections 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_collection_api_v1_collections_post
|
|
|
|
- Operation ID: `api_create_collection_api_v1_collections_post`
|
|
- Route: `POST /api/v1/collections/`
|
|
- Mode: WRITE
|
|
- Summary: Create collection
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_collections_by_api_v1_collections_org_org_id_0c679cc6e7
|
|
|
|
- Operation ID: `api_get_collections_by_api_v1_collections_org_org_id_page_page_limit_limit_get`
|
|
- Route: `GET /api/v1/collections/org/{org_id}/page/{page}/limit/{limit}`
|
|
- Mode: READ
|
|
- Summary: List collections for org
|
|
- Parameters:
|
|
- `page` in `path` required
|
|
- `limit` in `path` required
|
|
- `org_id` in `path` required
|
|
|
|
### api_delete_collection_api_v1_collections_collection_uuid_delete
|
|
|
|
- Operation ID: `api_delete_collection_api_v1_collections_collection_uuid_delete`
|
|
- Route: `DELETE /api/v1/collections/{collection_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete collection
|
|
- Parameters:
|
|
- `collection_uuid` in `path` required
|
|
|
|
### api_get_collection_api_v1_collections_collection_uuid_get
|
|
|
|
- Operation ID: `api_get_collection_api_v1_collections_collection_uuid_get`
|
|
- Route: `GET /api/v1/collections/{collection_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get collection
|
|
- Parameters:
|
|
- `collection_uuid` in `path` required
|
|
|
|
### api_update_collection_api_v1_collections_collection_uuid_put
|
|
|
|
- Operation ID: `api_update_collection_api_v1_collections_collection_uuid_put`
|
|
- Route: `PUT /api/v1/collections/{collection_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update collection
|
|
- Parameters:
|
|
- `collection_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|