API Property Require Team

api-property-require-team

Has a Team Defined

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-team:
  title: API Property Require Team
  reference: https://spotlight-rules.com/spec/rules/apis-json/api-property-require-team/
  description: This property ensures that there is a reference to the team behind
    an API, providing a reference to business and engineering stakeholders.
  message: Has a Team Defined
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(team|teams|Team|Teams)\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 'api-property-require-team' (API Property Require Team).
    Requirement: This property ensures that there is a reference to the team
    behind an API, providing a reference to business and engineering
    stakeholders. To fix: Ensure `type` does NOT match the regular expression
    `\\b(team|teams|Team|Teams)\\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-team' (API Property Require Team). Requirement: This property ensures that there is a reference to the team behind an API, providing a reference to business and engineering stakeholders. To fix: Ensure `type` does NOT match the regular expression `\b(team|teams|Team|Teams)\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.