Document Require Webhooks

document-require-webhooks

Missing `webhooks`.

Rule definition

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

document-require-webhooks:
  title: Document Require Webhooks
  reference: https://spotlight-rules.com/spec/rules/openapi/document-require-webhooks/
  description: openapi document should declare a `webhooks` property.
  message: Missing `webhooks`.
  given: $
  severity: info
  then:
    field: webhooks
    function: truthy
  tags:
    - format:openapi
    - spec:document
    - experience:governance
    - experience:discoverability
  prompt: "You are editing an OpenAPI document to satisfy the Spotlight API
    governance rule 'document-require-webhooks' (Document Require Webhooks).
    Requirement: openapi document should declare a `webhooks` property. To fix:
    Ensure `webhooks` is present and non-empty at each matching location.
    Guidance: Missing `webhooks`. Make the smallest change that satisfies the
    rule, leave all unrelated content, key order, comments, and formatting
    unchanged, and keep the document valid OpenAPI. Return only the complete
    corrected document, with no commentary."

You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-webhooks' (Document Require Webhooks). Requirement: openapi document should declare a `webhooks` property. To fix: Ensure `webhooks` is present and non-empty at each matching location. Guidance: Missing `webhooks`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary.