HTTP_011_SCHEMA_DOCUMENTATION: Schemas sind maschinenlesbar

Severity: should. Bereich: http-api.

Regel

JSON-Requests und -Responses SOLLTEN per OpenAPI 3.1 und JSON Schema beschrieben werden, inklusive Pflichtfeldern, Formaten, Enums und Fehlervarianten.

Reflection-Check

check:
  reflect:
    fields:
    - schema_ref
    object: representation

Evidence

• OPENAPI31, OpenAPI Specification 3.1
• JSON_SCHEMA_2020_12, JSON Schema Draft 2020-12 Core

alle Regeln dieses Bereichs