Schema Include Discussion Forum

schema-include-discussion-forum

Has Discussion Forum

Rule definition

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

schema-include-discussion-forum:
  title: Schema Include Discussion Forum
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-discussion-forum/
  description: This property ensures that there is a link to a discussion forum,
    providing a way for consumers and producers to engage and support either
    other throughout the lifecycle.
  message: Has Discussion Forum
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(Forums|Forums|Discussions)\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 'schema-include-discussion-forum' (Schema Include Discussion
    Forum). Requirement: This property ensures that there is a link to a
    discussion forum, providing a way for consumers and producers to engage and
    support either other throughout the lifecycle. To fix: Ensure `type` does
    NOT match the regular expression `\\b(Forums|Forums|Discussions)\\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-discussion-forum' (Schema Include Discussion Forum). Requirement: This property ensures that there is a link to a discussion forum, providing a way for consumers and producers to engage and support either other throughout the lifecycle. To fix: Ensure `type` does NOT match the regular expression `\b(Forums|Forums|Discussions)\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.