50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
---
|
|
name: reviews-routes
|
|
description: Handle 3 OpenAPI operation(s) under /v1/reviews for the reviews route group.
|
|
---
|
|
|
|
# reviews API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /v1/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 /v1/reviews`
|
|
- Mode: READ
|
|
- Summary: List all open reviews
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_reviews_review
|
|
|
|
- Operation ID: `get_reviews_review`
|
|
- Route: `GET /v1/reviews/{review}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a review
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `review` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_reviews_review_approve
|
|
|
|
- Operation ID: `post_reviews_review_approve`
|
|
- Route: `POST /v1/reviews/{review}/approve`
|
|
- Mode: WRITE
|
|
- Summary: Approve a review
|
|
- Parameters:
|
|
- `review` in `path` required
|
|
- Body: JSON request body accepted.
|