server_update
server_update is implemented by handleServerUpdate in src/api/handlers/server/server_update.osl.
Handles the server update 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: "server_update" and may include an opaque listener correlation value.
| Field | Validation / meaning |
|---|---|
name |
schema.string().nullable() |
icon |
schema.string().nullable() |
banner |
schema.string().nullable() |
contains |
Read separately by the handler or a shared domain helper |
Validator source
Section titled “Validator source”The handler and shared validation path use these OSL schema definitions before normalization:
*schema.Schema schemaServerUpdate = schema.object({ name: schema.string().nullable(), icon: schema.string().nullable(), banner: schema.string().nullable()}).partial()Processing path
Section titled “Processing path”handleCmdenforces authentication and themanage_serverpermission.dispatchCmdroutesserver_updatetohandleServerUpdate.- 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: configApply, auditRecord, configGetString, getServerInfo, broadcastAuthed
Responses and events
Section titled “Responses and events”Response/event command names visible in this adapter: server_update.
Validation and domain failures use:
{ "cmd": "error", "val": "<message>", "src": "server_update", "listener": "<copied from request>"}