213 lines
5.2 KiB
Markdown
213 lines
5.2 KiB
Markdown
---
|
|
name: meta-routes
|
|
description: Handle 23 OpenAPI operation(s) under /api/v1/meta for the meta route group.
|
|
---
|
|
|
|
# meta API Routes
|
|
|
|
Handle 23 OpenAPI operation(s) under /api/v1/meta for the meta 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_application_user_schema
|
|
|
|
- Operation ID: `get_application_user_schema`
|
|
- Route: `GET /api/v1/meta/schemas/apps/{appId}/default`
|
|
- Mode: READ
|
|
- Summary: Retrieve the default app user schema for an app
|
|
- Parameters:
|
|
- `appId` in `path` required
|
|
|
|
### update_application_user_profile
|
|
|
|
- Operation ID: `update_application_user_profile`
|
|
- Route: `POST /api/v1/meta/schemas/apps/{appId}/default`
|
|
- Mode: WRITE
|
|
- Summary: Update the app user profile schema for an app
|
|
- Parameters:
|
|
- `appId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_group_schema
|
|
|
|
- Operation ID: `get_group_schema`
|
|
- Route: `GET /api/v1/meta/schemas/group/default`
|
|
- Mode: READ
|
|
- Summary: Retrieve the default group schema
|
|
|
|
### update_group_schema
|
|
|
|
- Operation ID: `update_group_schema`
|
|
- Route: `POST /api/v1/meta/schemas/group/default`
|
|
- Mode: WRITE
|
|
- Summary: Update the group profile schema
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_log_stream_schemas
|
|
|
|
- Operation ID: `list_log_stream_schemas`
|
|
- Route: `GET /api/v1/meta/schemas/logStream`
|
|
- Mode: READ
|
|
- Summary: List the log stream schemas
|
|
|
|
### get_log_stream_schema
|
|
|
|
- Operation ID: `get_log_stream_schema`
|
|
- Route: `GET /api/v1/meta/schemas/logStream/{logStreamType}`
|
|
- Mode: READ
|
|
- Summary: Retrieve the log stream schema for the schema type
|
|
- Parameters:
|
|
- `logStreamType` in `path` required
|
|
|
|
### list_linked_object_definitions
|
|
|
|
- Operation ID: `list_linked_object_definitions`
|
|
- Route: `GET /api/v1/meta/schemas/user/linkedObjects`
|
|
- Mode: READ
|
|
- Summary: List all linked object definitions
|
|
|
|
### create_linked_object_definition
|
|
|
|
- Operation ID: `create_linked_object_definition`
|
|
- Route: `POST /api/v1/meta/schemas/user/linkedObjects`
|
|
- Mode: WRITE
|
|
- Summary: Create a linked object definition
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_linked_object_definition
|
|
|
|
- Operation ID: `get_linked_object_definition`
|
|
- Route: `GET /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a linked object definition
|
|
- Parameters:
|
|
- `linkedObjectName` in `path` required
|
|
|
|
### delete_linked_object_definition
|
|
|
|
- Operation ID: `delete_linked_object_definition`
|
|
- Route: `DELETE /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a linked object definition
|
|
- Parameters:
|
|
- `linkedObjectName` in `path` required
|
|
|
|
### get_user_schema
|
|
|
|
- Operation ID: `get_user_schema`
|
|
- Route: `GET /api/v1/meta/schemas/user/{schemaId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a user schema
|
|
- Parameters:
|
|
- `schemaId` in `path` required
|
|
|
|
### update_user_profile
|
|
|
|
- Operation ID: `update_user_profile`
|
|
- Route: `POST /api/v1/meta/schemas/user/{schemaId}`
|
|
- Mode: WRITE
|
|
- Summary: Update a user schema
|
|
- Parameters:
|
|
- `schemaId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_user_types
|
|
|
|
- Operation ID: `list_user_types`
|
|
- Route: `GET /api/v1/meta/types/user`
|
|
- Mode: READ
|
|
- Summary: List all user types
|
|
|
|
### create_user_type
|
|
|
|
- Operation ID: `create_user_type`
|
|
- Route: `POST /api/v1/meta/types/user`
|
|
- Mode: WRITE
|
|
- Summary: Create a user type
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_user_type
|
|
|
|
- Operation ID: `get_user_type`
|
|
- Route: `GET /api/v1/meta/types/user/{typeId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a user type
|
|
- Parameters:
|
|
- `typeId` in `path` required
|
|
|
|
### update_user_type
|
|
|
|
- Operation ID: `update_user_type`
|
|
- Route: `POST /api/v1/meta/types/user/{typeId}`
|
|
- Mode: WRITE
|
|
- Summary: Update a user type
|
|
- Parameters:
|
|
- `typeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### replace_user_type
|
|
|
|
- Operation ID: `replace_user_type`
|
|
- Route: `PUT /api/v1/meta/types/user/{typeId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a user type
|
|
- Parameters:
|
|
- `typeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_user_type
|
|
|
|
- Operation ID: `delete_user_type`
|
|
- Route: `DELETE /api/v1/meta/types/user/{typeId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a user type
|
|
- Parameters:
|
|
- `typeId` in `path` required
|
|
|
|
### list_ui_schemas
|
|
|
|
- Operation ID: `list_ui_schemas`
|
|
- Route: `GET /api/v1/meta/uischemas`
|
|
- Mode: READ
|
|
- Summary: List all UI schemas
|
|
|
|
### create_ui_schema
|
|
|
|
- Operation ID: `create_ui_schema`
|
|
- Route: `POST /api/v1/meta/uischemas`
|
|
- Mode: WRITE
|
|
- Summary: Create a UI schema
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_ui_schema
|
|
|
|
- Operation ID: `get_ui_schema`
|
|
- Route: `GET /api/v1/meta/uischemas/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a UI schema
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### replace_ui_schemas
|
|
|
|
- Operation ID: `replace_ui_schemas`
|
|
- Route: `PUT /api/v1/meta/uischemas/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a UI schema
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_ui_schemas
|
|
|
|
- Operation ID: `delete_ui_schemas`
|
|
- Route: `DELETE /api/v1/meta/uischemas/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a UI schema
|
|
- Parameters:
|
|
- `id` in `path` required
|