Anypoint Best Practices

headers-must-have-descriptions

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
TypeRuleset
OrganizationMuleSoft
Published by
Mulesoft Organization
Published onOct 26, 2026
Asset overview

Asset versions for 1.7.x

Asset versions
VersionActions
1.7.0

Tags