80 lines
2.0 KiB
Markdown
80 lines
2.0 KiB
Markdown
---
|
|
name: log-streams-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/v1/logStreams for the logStreams route group.
|
|
---
|
|
|
|
# logStreams API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/v1/logStreams for the logStreams 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
|
|
|
|
### list_log_streams
|
|
|
|
- Operation ID: `list_log_streams`
|
|
- Route: `GET /api/v1/logStreams`
|
|
- Mode: READ
|
|
- Summary: List all log streams
|
|
- Parameters:
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `filter` in `query`
|
|
|
|
### create_log_stream
|
|
|
|
- Operation ID: `create_log_stream`
|
|
- Route: `POST /api/v1/logStreams`
|
|
- Mode: WRITE
|
|
- Summary: Create a log stream
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_log_stream
|
|
|
|
- Operation ID: `get_log_stream`
|
|
- Route: `GET /api/v1/logStreams/{logStreamId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a log stream
|
|
- Parameters:
|
|
- `logStreamId` in `path` required
|
|
|
|
### replace_log_stream
|
|
|
|
- Operation ID: `replace_log_stream`
|
|
- Route: `PUT /api/v1/logStreams/{logStreamId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a log stream
|
|
- Parameters:
|
|
- `logStreamId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_log_stream
|
|
|
|
- Operation ID: `delete_log_stream`
|
|
- Route: `DELETE /api/v1/logStreams/{logStreamId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a log stream
|
|
- Parameters:
|
|
- `logStreamId` in `path` required
|
|
|
|
### activate_log_stream
|
|
|
|
- Operation ID: `activate_log_stream`
|
|
- Route: `POST /api/v1/logStreams/{logStreamId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate a log stream
|
|
- Parameters:
|
|
- `logStreamId` in `path` required
|
|
|
|
### deactivate_log_stream
|
|
|
|
- Operation ID: `deactivate_log_stream`
|
|
- Route: `POST /api/v1/logStreams/{logStreamId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate a log stream
|
|
- Parameters:
|
|
- `logStreamId` in `path` required
|