MUST

MUST use problem json for errors

The content type for 4xx and 5xx status codes MUST be application/problem+json.

For openapi definitions marked with info.x-api-type: pygeoapi, this rule’s severity is automatically set to warn by the override-severity-pygeoapi rule. See 1.

Invalid Example

The content type for the 503 response in this example incorrectly uses the application/json content type.

responses:
   '503':
     description: ...
     content:
       application/json:
         schema:
           $ref: ../models/Problem.yaml

Valid Example

The content type for the 503 response in this example correctly uses the application/problem+json content type.

responses:
   '503':
     description: ...
     content:
       application/problem+json:
         schema:
           $ref: ../models/Problem.yaml

Zalando Guideline 176

---

Published: 24 January 2025
Last updated: 25 September 2025
Page Source