118 lines
2.7 KiB
Markdown
118 lines
2.7 KiB
Markdown
---
|
|
name: templates-routes
|
|
description: Handle 10 OpenAPI operation(s) under /templates for the templates route group.
|
|
---
|
|
|
|
# templates API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /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
|
|
|
|
### template_version_retrieve
|
|
|
|
- Operation ID: `template_version_retrieve`
|
|
- Route: `GET /templates/{tmpl_id}/versions/{vrsn_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- `vrsn_id` in `path` required
|
|
|
|
### template_version_update
|
|
|
|
- Operation ID: `template_version_update`
|
|
- Route: `POST /templates/{tmpl_id}/versions/{vrsn_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- `vrsn_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### template_version_delete
|
|
|
|
- Operation ID: `template_version_delete`
|
|
- Route: `DELETE /templates/{tmpl_id}/versions/{vrsn_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- `vrsn_id` in `path` required
|
|
|
|
### template_versions_list
|
|
|
|
- Operation ID: `template_versions_list`
|
|
- Route: `GET /templates/{tmpl_id}/versions`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
- `date_created` in `query`
|
|
|
|
### create_template_version
|
|
|
|
- Operation ID: `create_template_version`
|
|
- Route: `POST /templates/{tmpl_id}/versions`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### template_retrieve
|
|
|
|
- Operation ID: `template_retrieve`
|
|
- Route: `GET /templates/{tmpl_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
|
|
### template_update
|
|
|
|
- Operation ID: `template_update`
|
|
- Route: `POST /templates/{tmpl_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### template_delete
|
|
|
|
- Operation ID: `template_delete`
|
|
- Route: `DELETE /templates/{tmpl_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `tmpl_id` in `path` required
|
|
|
|
### templates_list
|
|
|
|
- Operation ID: `templates_list`
|
|
- Route: `GET /templates`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
- `date_created` in `query`
|
|
- `metadata` in `query`
|
|
|
|
### create_template
|
|
|
|
- Operation ID: `create_template`
|
|
- Route: `POST /templates`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Body: JSON request body accepted.
|