Document Include Rest Canvas

document-include-rest-canvas

Has APIOps Cycles Locations Canvas

Rule definition

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

document-include-rest-canvas:
  title: Document Include Rest Canvas
  reference: https://spotlight-rules.com/spec/rules/apis-json/document-include-rest-canvas/
  description: This ensures that an API has had the APIOps Locations Canvas
    applied to the API, requiring that the canvas is present in the repository
    and registered in the APIs.json index for the API, helping with discovery
    and governance.
  message: Has APIOps Cycles Locations Canvas
  severity: info
  given:
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(APIOpsRestCanvas)\b
  tags:
    - format:apis-json
    - spec:collection
    - experience:governance
    - experience:documentation
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'document-include-rest-canvas' (Document Include Rest
    Canvas). Requirement: This ensures that an API has had the APIOps Locations
    Canvas applied to the API, requiring that the canvas is present in the
    repository and registered in the APIs.json index for the API, helping with
    discovery and governance. To fix: Ensure `type` does NOT match the regular
    expression `\\b(APIOpsRestCanvas)\\b`; rename or rewrite any value that
    does. This rule is evaluated at the JSONPath `$.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 'document-include-rest-canvas' (Document Include Rest Canvas). Requirement: This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\b(APIOpsRestCanvas)\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.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.