Datagraph Best Practices

general > missing-property-description

Guidance

The unified schema reuses schema property descriptions as type descriptions.

Message

The property '{{shacl.name}}' is missing a description.

Examples

valid

schemas:
  User:
    type: object
    properties:
      name:
        description: The name of the user
        type: string

invalid

schemas:
  User:
    type: object
    properties:
      name:
        # missing description
        type: string

Applies to PropertyShape

Constraint

Type: Declarative Validation