Document Require Aid

document-require-aid

info experience: governanceexperience: discoverability spec: document

Missing `aid`.

apis-json document should declare a aid property.

Rule definition

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

document-require-aid:
  title: Document Require Aid
  reference: https://spotlight-rules.com/spec/rules/apis-json/document-require-aid/
  description: apis-json document should declare a `aid` property.
  message: Missing `aid`.
  given: $
  severity: info
  then:
    field: aid
    function: truthy
  tags:
    - format:apis-json
    - spec:document
    - experience:governance
    - experience:discoverability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'document-require-aid' (Document Require Aid). Requirement:
    apis-json document should declare a `aid` property. To fix: Ensure `aid` is
    present and non-empty at each matching location. 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 'document-require-aid' (Document Require Aid). Requirement: apis-json document should declare a `aid` property. To fix: Ensure `aid` is present and non-empty at each matching location. 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.
ArtifactAPIs.json
Applies at (given)$
Severityinfo — educational by default; raise to warn/error to enforce
Referencehttps://spotlight-rules.com/spec/rules/apis-json/document-require-aid/