Schema Include Documentation

schema-include-documentation

Has Documentation

Rule definition

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

schema-include-documentation:
  title: Schema Include Documentation
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-documentation/
  description: This property ensures that there is documentation published for an
    API, and API consumers will have a set of human-readable instructions for
    onboarding and integrating with HTTP APIs in their applications.
  message: Has Documentation
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(documentation|Documentation)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:documentation
    - experience:usability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-documentation' (Schema Include
    Documentation). Requirement: This property ensures that there is
    documentation published for an API, and API consumers will have a set of
    human-readable instructions for onboarding and integrating with HTTP APIs in
    their applications. To fix: Ensure `type` does NOT match the regular
    expression `\\b(documentation|Documentation)\\b`; rename or rewrite any
    value that does. This rule is evaluated at the JSONPath
    `$.apis.*.properties.* | $.common.*` — 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 APIs.json. Return only the complete
    corrected document, with no commentary."

You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-documentation' (Schema Include Documentation). Requirement: This property ensures that there is documentation published for an API, and API consumers will have a set of human-readable instructions for onboarding and integrating with HTTP APIs in their applications. To fix: Ensure `type` does NOT match the regular expression `\b(documentation|Documentation)\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — 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 APIs.json. Return only the complete corrected document, with no commentary.