Required Examples

general > provide-examples-on-payloads

Guidance / Message

{{shacl.name}} must include examples in requests and responses.

Examples

valid

responses:
  200:
    description: Ok!
    body:
      application/json:
        type: string
        example: Hello!

invalid

responses:
  200:
    description: Ok!
    body:
      application/json:
        type: string # no example here

Applies to Payload

Constraint

Type: Rego Validation