46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
---
|
|
name: mappings-routes
|
|
description: Handle 3 OpenAPI operation(s) under /api/v1/mappings for the mappings route group.
|
|
---
|
|
|
|
# mappings API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /api/v1/mappings for the mappings 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
|
|
|
|
### list_profile_mappings
|
|
|
|
- Operation ID: `list_profile_mappings`
|
|
- Route: `GET /api/v1/mappings`
|
|
- Mode: READ
|
|
- Summary: List all profile mappings
|
|
- Parameters:
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `sourceId` in `query`
|
|
- `targetId` in `query`
|
|
|
|
### get_profile_mapping
|
|
|
|
- Operation ID: `get_profile_mapping`
|
|
- Route: `GET /api/v1/mappings/{mappingId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a profile mapping
|
|
- Parameters:
|
|
- `mappingId` in `path` required
|
|
|
|
### update_profile_mapping
|
|
|
|
- Operation ID: `update_profile_mapping`
|
|
- Route: `POST /api/v1/mappings/{mappingId}`
|
|
- Mode: WRITE
|
|
- Summary: Update a profile mapping
|
|
- Parameters:
|
|
- `mappingId` in `path` required
|
|
- Body: JSON request body accepted.
|