Schema Include Privacy Policy

schema-include-privacy-policy

info experience: governanceexperience: documentation spec: apisspec: properties

Has an API Privacy Policy

This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API.

Rule definition

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

schema-include-privacy-policy:
  title: Schema Include Privacy Policy
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-privacy-policy/
  description: This property provides a link to the privacy policy for an API,
    providing the legal details of how privacy is approached for each API.
  message: Has an API Privacy Policy
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(api-privacy-policy|privacy-policy|Privacy|Privacy
          Policy|PrivacyPolicy)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:governance
    - experience:documentation
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-privacy-policy' (Schema Include Privacy
    Policy). Requirement: This property provides a link to the privacy policy
    for an API, providing the legal details of how privacy is approached for
    each API. To fix: Ensure `type` does NOT match the regular expression
    `\\b(api-privacy-policy|privacy-policy|Privacy|Privacy
    Policy|PrivacyPolicy)\\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."

AI fix prompt — send this to Claude, Gemini, or ChatGPT with your artifact to auto-fix this rule

You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-privacy-policy' (Schema Include Privacy Policy). Requirement: This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API. To fix: Ensure `type` does NOT match the regular expression `\b(api-privacy-policy|privacy-policy|Privacy|Privacy Policy|PrivacyPolicy)\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.

Artifact	APIs.json
Applies at (given)	`$.apis..properties. \| $.common.*`
Severity	info — educational by default; raise to `warn`/`error` to enforce
Reference	`https://spotlight-rules.com/spec/rules/apis-json/schema-include-privacy-policy/`

← Schema Include Pricing

all APIs.json rules

Schema Include Production Environment →