Anypoint Best Practices

node-shapes-must-have-descriptions

general > node-shapes-must-have-descriptions


Guidance / Message

Shape '{{shacl.name}}' should have a description.

Examples

valid

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

invalid

types:
  MessageResult:
    type: object # missing description
    additionalProperties: false
    properties:
      count:
        type: integer

Applies to NodeShape

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