70 lines
1.6 KiB
Markdown
70 lines
1.6 KiB
Markdown
---
|
|
name: events-routes
|
|
description: Handle 6 OpenAPI operation(s) under /events for the events route group.
|
|
---
|
|
|
|
# events API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /events for the events 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_events
|
|
|
|
- Operation ID: `post_events`
|
|
- Route: `POST /events`
|
|
- Mode: WRITE
|
|
- Summary: Create an event
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_events
|
|
|
|
- Operation ID: `get_events`
|
|
- Route: `GET /events`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of events
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### post_events_send
|
|
|
|
- Operation ID: `post_events_send`
|
|
- Route: `POST /events/send`
|
|
- Mode: WRITE
|
|
- Summary: Send an event
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_events_identifier
|
|
|
|
- Operation ID: `get_events_identifier`
|
|
- Route: `GET /events/{identifier}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single event
|
|
- Parameters:
|
|
- `identifier` in `path` required
|
|
|
|
### patch_events_identifier
|
|
|
|
- Operation ID: `patch_events_identifier`
|
|
- Route: `PATCH /events/{identifier}`
|
|
- Mode: WRITE
|
|
- Summary: Update an event
|
|
- Parameters:
|
|
- `identifier` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_events_identifier
|
|
|
|
- Operation ID: `delete_events_identifier`
|
|
- Route: `DELETE /events/{identifier}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an event
|
|
- Parameters:
|
|
- `identifier` in `path` required
|