63 lines
1.5 KiB
Markdown
63 lines
1.5 KiB
Markdown
---
|
|
name: images-routes
|
|
description: Handle 4 OpenAPI operation(s) under /api/images for the images route group.
|
|
---
|
|
|
|
# images API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /api/images for the images 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_images
|
|
|
|
- Operation ID: `get_images`
|
|
- Route: `GET /api/images`
|
|
- Mode: READ
|
|
- Summary: Get Images
|
|
- Parameters:
|
|
- `fields[image]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### upload_image_from_url
|
|
|
|
- Operation ID: `upload_image_from_url`
|
|
- Route: `POST /api/images`
|
|
- Mode: WRITE
|
|
- Summary: Upload Image From URL
|
|
- Parameters:
|
|
- `fields[image]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_image
|
|
|
|
- Operation ID: `get_image`
|
|
- Route: `GET /api/images/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Image
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[image]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_image
|
|
|
|
- Operation ID: `update_image`
|
|
- Route: `PATCH /api/images/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Image
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[image]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|