56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
---
|
|
name: reviews-routes
|
|
description: Handle 3 OpenAPI operation(s) under /api/reviews for the reviews route group.
|
|
---
|
|
|
|
# reviews API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /api/reviews for the reviews 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_reviews
|
|
|
|
- Operation ID: `get_reviews`
|
|
- Route: `GET /api/reviews`
|
|
- Mode: READ
|
|
- Summary: Get Reviews
|
|
- Parameters:
|
|
- `fields[event]` in `query`
|
|
- `fields[review]` in `query`
|
|
- `filter` in `query`
|
|
- `include` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_review
|
|
|
|
- Operation ID: `get_review`
|
|
- Route: `GET /api/reviews/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Review
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[event]` in `query`
|
|
- `fields[review]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_review
|
|
|
|
- Operation ID: `update_review`
|
|
- Route: `PATCH /api/reviews/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Review
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[review]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|