54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
---
|
|
name: addresses-routes
|
|
description: Handle 4 OpenAPI operation(s) under /addresses for the addresses route group.
|
|
---
|
|
|
|
# addresses API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /addresses for the addresses 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
|
|
|
|
### addresses_list
|
|
|
|
- Operation ID: `addresses_list`
|
|
- Route: `GET /addresses`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
- `date_created` in `query`
|
|
- `metadata` in `query`
|
|
|
|
### address_create
|
|
|
|
- Operation ID: `address_create`
|
|
- Route: `POST /addresses`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Body: JSON request body accepted.
|
|
|
|
### address_retrieve
|
|
|
|
- Operation ID: `address_retrieve`
|
|
- Route: `GET /addresses/{adr_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `adr_id` in `path` required
|
|
|
|
### address_delete
|
|
|
|
- Operation ID: `address_delete`
|
|
- Route: `DELETE /addresses/{adr_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `adr_id` in `path` required
|