Schema Include Github Organization

schema-include-github-organization

Has a GitHub Organization

Rule definition

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

schema-include-github-organization:
  title: Schema Include Github Organization
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-organization/
  description: This property ensures that an API is associated with GitHub
    organization, providing the URL to where you can engage with the operations
    surrounding an API.
  message: Has a GitHub Organization
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(github-organization|GitHubOrganization)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:discoverability
    - experience:documentation
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-github-organization' (Schema Include Github
    Organization). Requirement: This property ensures that an API is associated
    with GitHub organization, providing the URL to where you can engage with the
    operations surrounding an API. To fix: Ensure `type` does NOT match the
    regular expression `\\b(github-organization|GitHubOrganization)\\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 'schema-include-github-organization' (Schema Include Github Organization). Requirement: This property ensures that an API is associated with GitHub organization, providing the URL to where you can engage with the operations surrounding an API. To fix: Ensure `type` does NOT match the regular expression `\b(github-organization|GitHubOrganization)\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.