API Property Require Video

api-property-require-video

Has Videos for API

Rule definition

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

api-property-require-video:
  title: API Property Require Video
  reference: https://spotlight-rules.com/spec/rules/apis-json/api-property-require-video/
  description: This property ensures there is a reference to a video page or
    channel for an API.
  message: Has Videos for API
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(videos|Videos)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:documentation
    - experience:discoverability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'api-property-require-video' (API Property Require Video).
    Requirement: This property ensures there is a reference to a video page or
    channel for an API. To fix: Ensure `type` does NOT match the regular
    expression `\\b(videos|Videos)\\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 'api-property-require-video' (API Property Require Video). Requirement: This property ensures there is a reference to a video page or channel for an API. To fix: Ensure `type` does NOT match the regular expression `\b(videos|Videos)\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.