Schema Include Openapi Validator

schema-include-openapi-validator

Has OpenAPI (Technical) Validator

Rule definition

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

schema-include-openapi-validator:
  title: Schema Include Openapi Validator
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-validator/
  description: This property ensures that there is a link to the validator for the
    OpenAPI technical contract, allowing anyone to see the details of governance
    being applied.
  message: Has OpenAPI (Technical) Validator
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(APIValidation)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:governance
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-openapi-validator' (Schema Include Openapi
    Validator). Requirement: This property ensures that there is a link to the
    validator for the OpenAPI technical contract, allowing anyone to see the
    details of governance being applied. To fix: Ensure `type` does NOT match
    the regular expression `\\b(APIValidation)\\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-openapi-validator' (Schema Include Openapi Validator). Requirement: This property ensures that there is a link to the validator for the OpenAPI technical contract, allowing anyone to see the details of governance being applied. To fix: Ensure `type` does NOT match the regular expression `\b(APIValidation)\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.