API Property Require SDK

api-property-require-sdk

Has SDK

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-sdk:
  title: API Property Require SDK
  reference: https://spotlight-rules.com/spec/rules/apis-json/api-property-require-sdk/
  description: This property ensures that there is an SDK available for an API,
    making it easier for developers to integrate an API into their applications.
  message: Has SDK
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(sdk|sdks|SDKs)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:usability
    - experience:discoverability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'api-property-require-sdk' (API Property Require SDK).
    Requirement: This property ensures that there is an SDK available for an
    API, making it easier for developers to integrate an API into their
    applications. To fix: Ensure `type` does NOT match the regular expression
    `\\b(sdk|sdks|SDKs)\\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-sdk' (API Property Require SDK). Requirement: This property ensures that there is an SDK available for an API, making it easier for developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\b(sdk|sdks|SDKs)\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.