Schema Include Performance Testing

schema-include-performance-testing

Has API Performance

Rule definition

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

schema-include-performance-testing:
  title: Schema Include Performance Testing
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-performance-testing/
  description: This property ensures that an API has performance testing in place,
    providing a URL to the performance testing, dashboard, or other resource.
  message: Has API Performance
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(Performance|PerformanceTesting)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:reliability
    - experience:documentation
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-performance-testing' (Schema Include
    Performance Testing). Requirement: This property ensures that an API has
    performance testing in place, providing a URL to the performance testing,
    dashboard, or other resource. To fix: Ensure `type` does NOT match the
    regular expression `\\b(Performance|PerformanceTesting)\\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-performance-testing' (Schema Include Performance Testing). Requirement: This property ensures that an API has performance testing in place, providing a URL to the performance testing, dashboard, or other resource. To fix: Ensure `type` does NOT match the regular expression `\b(Performance|PerformanceTesting)\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.