77 lines
1.9 KiB
Markdown
77 lines
1.9 KiB
Markdown
---
|
|
name: templates-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/templates for the templates route group.
|
|
---
|
|
|
|
# templates API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/templates for the templates 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_templates
|
|
|
|
- Operation ID: `get_templates`
|
|
- Route: `GET /api/templates`
|
|
- Mode: READ
|
|
- Summary: Get Templates
|
|
- Parameters:
|
|
- `additional-fields[template]` in `query`
|
|
- `fields[template]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_template
|
|
|
|
- Operation ID: `create_template`
|
|
- Route: `POST /api/templates`
|
|
- Mode: WRITE
|
|
- Summary: Create Template
|
|
- Parameters:
|
|
- `additional-fields[template]` in `query`
|
|
- `fields[template]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_template
|
|
|
|
- Operation ID: `get_template`
|
|
- Route: `GET /api/templates/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Template
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[template]` in `query`
|
|
- `fields[template]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_template
|
|
|
|
- Operation ID: `update_template`
|
|
- Route: `PATCH /api/templates/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Template
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[template]` in `query`
|
|
- `fields[template]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_template
|
|
|
|
- Operation ID: `delete_template`
|
|
- Route: `DELETE /api/templates/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Template
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|