API Include About Page

api-include-about-page

Has About

Rule definition

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

api-include-about-page:
  title: API Include About Page
  reference: https://spotlight-rules.com/spec/rules/apis-json/api-include-about-page/
  description: This property ensures provides a reference to an about page, either
    for the company, organization, or government agency behind an API, or
    specifically about the domain, team, and the APIs they produce.
  message: Has About
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(about|About)\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-include-about-page' (API Include About Page).
    Requirement: This property ensures provides a reference to an about page,
    either for the company, organization, or government agency behind an API, or
    specifically about the domain, team, and the APIs they produce. To fix:
    Ensure `type` does NOT match the regular expression `\\b(about|About)\\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-include-about-page' (API Include About Page). Requirement: This property ensures provides a reference to an about page, either for the company, organization, or government agency behind an API, or specifically about the domain, team, and the APIs they produce. To fix: Ensure `type` does NOT match the regular expression `\b(about|About)\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.