Header Require Examples

header-require-examples

{{description}}; missing {{property}}

Rule definition

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

header-require-examples:
  title: Header Require Examples
  reference: https://spotlight-rules.com/spec/rules/openapi/header-require-examples/
  description: Headers must include examples.
  message: "{{description}}; missing {{property}}"
  severity: info
  given: $..headers.*
  then:
    function: digitalocean:ensurePropertiesExample
  tags:
    - format:openapi
    - spec:headers
    - experience:documentation
    - experience:usability
  prompt: "You are editing an OpenAPI document to satisfy the Spotlight API
    governance rule 'header-require-examples' (Header Require Examples).
    Requirement: Headers must include examples. This rule is evaluated at the
    JSONPath `$..headers.*` — 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 'header-require-examples' (Header Require Examples). Requirement: Headers must include examples. This rule is evaluated at the JSONPath `$..headers.*` — 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.