52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
---
|
|
name: segments-routes
|
|
description: Handle 4 OpenAPI operation(s) under /segments for the segments route group.
|
|
---
|
|
|
|
# segments API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /segments for the segments 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
|
|
|
|
### post_segments
|
|
|
|
- Operation ID: `post_segments`
|
|
- Route: `POST /segments`
|
|
- Mode: WRITE
|
|
- Summary: Create a new segment
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_segments
|
|
|
|
- Operation ID: `get_segments`
|
|
- Route: `GET /segments`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of segments
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_segments_id
|
|
|
|
- Operation ID: `get_segments_id`
|
|
- Route: `GET /segments/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single segment
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### delete_segments_id
|
|
|
|
- Operation ID: `delete_segments_id`
|
|
- Route: `DELETE /segments/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove an existing segment
|
|
- Parameters:
|
|
- `id` in `path` required
|