Component Message Require Examples

component-message-require-examples

Message must have examples

Rule definition

The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.

component-message-require-examples:
  title: Component Message Require Examples
  reference: https://spotlight-rules.com/spec/rules/openapi/component-message-require-examples/
  description: Message must have examples.
  message: Message must have examples
  severity: info
  given: $.components.messages.*
  then:
    field: examples
    function: truthy
  formats:
    - aas3
  tags:
    - format:openapi
    - spec:messages
    - spec:components
    - experience:documentation
    - experience:usability
  prompt: "You are editing an OpenAPI document to satisfy the Spotlight API
    governance rule 'component-message-require-examples' (Component Message
    Require Examples). Requirement: Message must have examples. To fix: Ensure
    `examples` is present and non-empty at each matching location. This rule is
    evaluated at the JSONPath `$.components.messages.*` — inspect every location
    it matches and correct only what violates the rule. Make the smallest change
    that satisfies the rule, leave all unrelated content, key order, comments,
    and formatting unchanged, and keep the document valid OpenAPI. Return only
    the complete corrected document, with no commentary."

You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-message-require-examples' (Component Message Require Examples). Requirement: Message must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary.