Schema Include Version Comparison

schema-include-version-comparison

Has an API Comparison

Rule definition

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

schema-include-version-comparison:
  title: Schema Include Version Comparison
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-version-comparison/
  description: This property ensures that an API has the ability to compare two
    different versions of an API and see what the difference are between them.
  message: Has an API Comparison
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(compare|Compare)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:versioning
    - experience:documentation
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-version-comparison' (Schema Include Version
    Comparison). Requirement: This property ensures that an API has the ability
    to compare two different versions of an API and see what the difference are
    between them. To fix: Ensure `type` does NOT match the regular expression
    `\\b(compare|Compare)\\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-version-comparison' (Schema Include Version Comparison). Requirement: This property ensures that an API has the ability to compare two different versions of an API and see what the difference are between them. To fix: Ensure `type` does NOT match the regular expression `\b(compare|Compare)\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.