attachment_list
attachment_list is implemented by handleAttachmentList in src/api/handlers/attachment/attachment_list.osl.
Handles the attachment list protocol operation through the resource-specific helper and storage layers.
Access
Section titled “Access”| Gate | Requirement |
|---|---|
| Authentication | Required by the central API gate. |
| Central permission | manage_server |
| Broadcast | Not marked global directly by this adapter. A helper may emit focused or server-wide updates. |
Request
Section titled “Request”Every request includes cmd: "attachment_list" and may include an opaque listener correlation value.
| Field | Validation / meaning |
|---|---|
offset |
schema.number().defaultValue(0) |
limit |
schema.number().defaultValue(50) |
Validator source
Section titled “Validator source”The handler and shared validation path use these OSL schema definitions before normalization:
*schema.Schema schemaAttachmentList = schema.object({ offset: schema.number().defaultValue(0), limit: schema.number().defaultValue(50)})Processing path
Section titled “Processing path”handleCmdenforces authentication and themanage_serverpermission.dispatchCmdroutesattachment_listtohandleAttachmentList.- The adapter validates and normalizes input, then calls its domain collaborators.
- Durable mutations complete before the response or event is returned.
onMessageadds the request listener to direct responses and performs any marked broadcast.
Direct collaborators visible in the handler: lock, attachmentListPage, unlock, true, attachmentPublic
Responses and events
Section titled “Responses and events”Response/event command names visible in this adapter: attachment_list.
Validation and domain failures use:
{ "cmd": "error", "val": "<message>", "src": "attachment_list", "listener": "<copied from request>"}