171 lines
5.3 KiB
Markdown
171 lines
5.3 KiB
Markdown
---
|
|
name: metadata-taxonomies-routes
|
|
description: Handle 14 OpenAPI operation(s) under /metadata_taxonomies for the metadata taxonomies route group.
|
|
---
|
|
|
|
# metadata taxonomies API Routes
|
|
|
|
Handle 14 OpenAPI operation(s) under /metadata_taxonomies for the metadata taxonomies 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
|
|
|
|
### post_metadata_taxonomies
|
|
|
|
- Operation ID: `post_metadata_taxonomies`
|
|
- Route: `POST /metadata_taxonomies`
|
|
- Mode: WRITE
|
|
- Summary: Create metadata taxonomy
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_metadata_taxonomies_id
|
|
|
|
- Operation ID: `get_metadata_taxonomies_id`
|
|
- Route: `GET /metadata_taxonomies/{namespace}`
|
|
- Mode: READ
|
|
- Summary: Get metadata taxonomies for namespace
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### get_metadata_taxonomies_id_id
|
|
|
|
- Operation ID: `get_metadata_taxonomies_id_id`
|
|
- Route: `GET /metadata_taxonomies/{namespace}/{taxonomy_key}`
|
|
- Mode: READ
|
|
- Summary: Get metadata taxonomy by taxonomy key
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
|
|
### patch_metadata_taxonomies_id_id
|
|
|
|
- Operation ID: `patch_metadata_taxonomies_id_id`
|
|
- Route: `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}`
|
|
- Mode: WRITE
|
|
- Summary: Update metadata taxonomy
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_metadata_taxonomies_id_id
|
|
|
|
- Operation ID: `delete_metadata_taxonomies_id_id`
|
|
- Route: `DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}`
|
|
- Mode: WRITE
|
|
- Summary: Remove metadata taxonomy
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
|
|
### post_metadata_taxonomies_id_id_levels
|
|
|
|
- Operation ID: `post_metadata_taxonomies_id_id_levels`
|
|
- Route: `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels`
|
|
- Mode: WRITE
|
|
- Summary: Create metadata taxonomy levels
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### patch_metadata_taxonomies_id_id_levels_id
|
|
|
|
- Operation ID: `patch_metadata_taxonomies_id_id_levels_id`
|
|
- Route: `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}`
|
|
- Mode: WRITE
|
|
- Summary: Update metadata taxonomy level
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- `level_index` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_metadata_taxonomies_id_id_levels_append
|
|
|
|
- Operation ID: `post_metadata_taxonomies_id_id_levels_append`
|
|
- Route: `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append`
|
|
- Mode: WRITE
|
|
- Summary: Add metadata taxonomy level
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_metadata_taxonomies_id_id_levels_trim
|
|
|
|
- Operation ID: `post_metadata_taxonomies_id_id_levels_trim`
|
|
- Route: `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim`
|
|
- Mode: WRITE
|
|
- Summary: Delete metadata taxonomy level
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
|
|
### get_metadata_taxonomies_id_id_nodes
|
|
|
|
- Operation ID: `get_metadata_taxonomies_id_id_nodes`
|
|
- Route: `GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes`
|
|
- Mode: READ
|
|
- Summary: List metadata taxonomy nodes
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- `level` in `query`
|
|
- `parent` in `query`
|
|
- `ancestor` in `query`
|
|
- `query` in `query`
|
|
- `include-total-result-count` in `query`
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### post_metadata_taxonomies_id_id_nodes
|
|
|
|
- Operation ID: `post_metadata_taxonomies_id_id_nodes`
|
|
- Route: `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes`
|
|
- Mode: WRITE
|
|
- Summary: Create metadata taxonomy node
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_metadata_taxonomies_id_id_nodes_id
|
|
|
|
- Operation ID: `get_metadata_taxonomies_id_id_nodes_id`
|
|
- Route: `GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
|
|
- Mode: READ
|
|
- Summary: Get metadata taxonomy node by ID
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- `node_id` in `path` required
|
|
|
|
### patch_metadata_taxonomies_id_id_nodes_id
|
|
|
|
- Operation ID: `patch_metadata_taxonomies_id_id_nodes_id`
|
|
- Route: `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update metadata taxonomy node
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- `node_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_metadata_taxonomies_id_id_nodes_id
|
|
|
|
- Operation ID: `delete_metadata_taxonomies_id_id_nodes_id`
|
|
- Route: `DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove metadata taxonomy node
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `taxonomy_key` in `path` required
|
|
- `node_id` in `path` required
|