Anypoint Best Practices

general > property-shape-ranges-must-have-descriptions

Guidance / Message

Provide descriptions for properties.

Examples

valid

types:
  MessgeResult:
    type: object
    additionalProperties: false
    properties:
      count:
        type: integer
        description: "some count"

invalid

types:
  MessgeResult:
    type: object
    additionalProperties: false
    properties:
      count:
        type: integer # no description here

Applies to PropertyShape

Constraint

Type: Declarative Validation