REST API Documentation Standards

Standard Metadata

Area: API
Owner: Backend Steering group
Last reviewed: 2026-09-09
Next review due from: 2026-12-01
Enforcement: CodeAnalysis / Code review
Status: Active

REST APIs must be documented using the OpenAPI standard · REST-01.1 · MUST · DEV

The following things must be included in the documentation:

Request types
Response types
Response codes