Anypoint Best Practices

general > headers-must-have-descriptions

Guidance / Message

Header '{{core.name}}' must have description.

Examples

valid

responses:
  200:
    description: All profiles
    headers:
      content-type:
        description: a header
        type: string
        example:
          'application/json'

invalid

responses:
  200:
    description: All profiles
    headers:
      content-type:
        type: string
        example:
          'application/json'

Applies to Parameter

Constraint

Type: Declarative Validation