Asyncapi Server Not Example Com

asyncapi-server-not-example-com · built-in

Server URL must not point at example.com.

Rule definition

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

asyncapi-server-not-example-com:
  title: Asyncapi Server Not Example Com
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-not-example-com/
  description: Server URL must not point at example.com.
  message: Server URL must not point at example.com.
  severity: info
  given: $.servers[*].url
  then:
    function: pattern
    functionOptions:
      notMatch: example\.com
  tags:
    - format:asyncapi
    - spec:servers
    - experience:reliability
    - experience:usability
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-server-not-example-com' (Asyncapi Server Not
    Example Com). Requirement: Server URL must not point at example.com. To fix:
    Ensure the targeted value does NOT match the regular expression
    `example\\.com`; rename or rewrite any value that does. This rule is
    evaluated at the JSONPath `$.servers[*].url` — 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 AsyncAPI. Return only
    the complete corrected document, with no commentary."

You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-not-example-com' (Asyncapi Server Not Example Com). Requirement: Server URL must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — 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 AsyncAPI. Return only the complete corrected document, with no commentary.