Accessibility Settings Repository
API Contract
REST
/api/v1/accessibility-settings
7 endpoints
GET
/api/v1/accessibility-settings/api/v1/accessibility-settings
List all accessibility setting keys and their current values
Public
Response Example
{
"data": [
{
"id": "as-001",
"key": "high_contrast_mode",
"value": "false",
"value_type": "boolean",
"updated_at": "2026-03-25T14:00:00Z"
},
{
"id": "as-002",
"key": "font_scale",
"value": "1.2",
"value_type": "float",
"updated_at": "2026-03-25T14:01:00Z"
},
{
"id": "as-003",
"key": "reduce_motion",
"value": "true",
"value_type": "boolean",
"updated_at": "2026-03-25T14:02:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 3
}
}
GET
/api/v1/accessibility-settings/api/v1/accessibility-settings/:id
Get a specific accessibility setting by its record ID
Public
Response Example
{
"id": "as-002",
"key": "font_scale",
"value": "1.2",
"value_type": "float",
"updated_at": "2026-03-25T14:01:00Z"
}
POST
/api/v1/accessibility-settings/api/v1/accessibility-settings
Create a new accessibility setting entry
Public
Request Example
{
"key": "screen_reader_hint_verbosity",
"value": "verbose",
"value_type": "string"
}
Response Example
{
"id": "as-004",
"key": "screen_reader_hint_verbosity",
"value": "verbose",
"value_type": "string",
"updated_at": "2026-03-26T12:20:00Z"
}
PUT
/api/v1/accessibility-settings/api/v1/accessibility-settings/:id
Update the value of an accessibility setting
Public
Request Example
{
"value": "concise"
}
Response Example
{
"id": "as-004",
"key": "screen_reader_hint_verbosity",
"value": "concise",
"value_type": "string",
"updated_at": "2026-03-26T12:25:00Z"
}
DELETE
/api/v1/accessibility-settings/api/v1/accessibility-settings/:id
Delete a custom accessibility setting record
Public
Response Example
{
"message": "Accessibility setting as-004 deleted"
}
POST
/api/v1/accessibility-settings/api/v1/accessibility-settings/reset
Reset all accessibility settings to their default values
Public
Request Example
{}
Response Example
{
"reset": true,
"reset_at": "2026-03-26T12:26:00Z",
"settings": [
{
"key": "high_contrast_mode",
"value": "false"
},
{
"key": "font_scale",
"value": "1.0"
},
{
"key": "reduce_motion",
"value": "false"
},
{
"key": "screen_reader_hint_verbosity",
"value": "standard"
}
]
}
GET
/api/v1/accessibility-settings/api/v1/accessibility-settings/key/:key
Retrieve a single accessibility setting by its string key
Public
Response Example
{
"id": "as-002",
"key": "font_scale",
"value": "1.2",
"value_type": "float",
"updated_at": "2026-03-25T14:01:00Z"
}