WCAG Semantics Label Resolver - API Contract

GET /api/v1/accessibility-labels/api/v1/accessibility-labels

List all WCAG semantics label mappings, optionally filtered by organization

Auth Required coordinatororg_adminglobal_admin

Response Example

{
  "data": [
    {
      "key": "role.coordinator",
      "semantics_label": "Programleder",
      "hint_key": "role.coordinator.hint",
      "hint_label": "Velg for å se koordinatorprofil",
      "organization_id": "org_nhf_oslo",
      "wcag_level": "AA"
    },
    {
      "key": "activity_type.group_walk",
      "semantics_label": "Fellestur",
      "hint_key": null,
      "hint_label": null,
      "organization_id": "org_nhf_oslo",
      "wcag_level": "AA"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 19
  }
}

GET /api/v1/accessibility-labels/api/v1/accessibility-labels/:key

Get WCAG semantics label for a specific key (maps to semanticsLabel())

Auth Required peer_mentorcoordinatororg_adminglobal_admin

Response Example

{
  "key": "role.coordinator",
  "semantics_label": "Programleder",
  "hint_key": "role.coordinator.hint",
  "hint_label": "Velg for å se koordinatorprofil",
  "organization_id": "org_nhf_oslo",
  "wcag_level": "AA",
  "is_live_region": false
}

POST /api/v1/accessibility-labels/api/v1/accessibility-labels

Create a WCAG semantics label mapping for a key

Auth Required org_adminglobal_admin

Request Example

{
  "key": "role.volunteer_lead",
  "organization_id": "org_nhf_oslo",
  "semantics_label": "Frivillig leder",
  "hint_key": "role.volunteer_lead.hint",
  "hint_label": "Velg for å se frivillig-profil",
  "wcag_level": "AA",
  "is_live_region": false
}

Response Example

{
  "key": "role.volunteer_lead",
  "organization_id": "org_nhf_oslo",
  "semantics_label": "Frivillig leder",
  "wcag_level": "AA",
  "created_at": "2026-03-26T10:05:00.000Z"
}

PUT /api/v1/accessibility-labels/api/v1/accessibility-labels/:key

Update WCAG semantics label text or hint for a key

Auth Required org_adminglobal_admin

Request Example

{
  "semantics_label": "Gruppeleder",
  "hint_label": "Velg for å se gruppeleder-profil"
}

Response Example

{
  "key": "role.volunteer_lead",
  "semantics_label": "Gruppeleder",
  "updated_at": "2026-03-26T10:07:00.000Z"
}

DELETE /api/v1/accessibility-labels/api/v1/accessibility-labels/:key

Remove a WCAG semantics label mapping

Auth Required org_adminglobal_admin

Response Example

{
  "key": "role.volunteer_lead",
  "deleted": true
}

POST /api/v1/accessibility-labels/api/v1/accessibility-labels/assert

Validate that a key has an accessible label in a given map (maps to assertAccessibleLabel())

Auth Required coordinatororg_adminglobal_admin

Request Example

{
  "key": "role.coordinator",
  "organization_id": "org_nhf_oslo"
}

Response Example

{
  "key": "role.coordinator",
  "is_accessible": true,
  "semantics_label": "Programleder",
  "wcag_level": "AA",
  "issues": []
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}