Anypoint Best Practices

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