Anypoint Best Practices

(14 reviews)

property-shape-ranges-must-have-descriptions

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

Reviews

TypeRuleset
OrganizationMuleSoft
Published by
MuleSoft Organization
Published onDec 11, 2023
Asset overview

Asset versions for 1.6.x

Asset versions
VersionActions
1.6.1
1.6.0

Tags