Document Require Defaultcontenttype

document-require-defaultcontenttype

info experience: governanceexperience: discoverability spec: document

Missing `defaultContentType`.

asyncapi document should declare a defaultContentType property.

Rule definition

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

document-require-defaultcontenttype:
  title: Document Require Defaultcontenttype
  reference: https://spotlight-rules.com/spec/rules/asyncapi/document-require-defaultcontenttype/
  description: asyncapi document should declare a `defaultContentType` property.
  message: Missing `defaultContentType`.
  given: $
  severity: info
  then:
    field: defaultContentType
    function: truthy
  tags:
    - format:asyncapi
    - spec:document
    - experience:governance
    - experience:discoverability
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'document-require-defaultcontenttype' (Document Require
    Defaultcontenttype). Requirement: asyncapi document should declare a
    `defaultContentType` property. To fix: Ensure `defaultContentType` is
    present and non-empty at each matching location. Guidance: Missing
    `defaultContentType`. 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."
AI fix prompt — send this to Claude, Gemini, or ChatGPT with your artifact to auto-fix this rule
You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-defaultcontenttype' (Document Require Defaultcontenttype). Requirement: asyncapi document should declare a `defaultContentType` property. To fix: Ensure `defaultContentType` is present and non-empty at each matching location. Guidance: Missing `defaultContentType`. 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.
ArtifactAsyncAPI
Applies at (given)$
Severityinfo — educational by default; raise to warn/error to enforce
Referencehttps://spotlight-rules.com/spec/rules/asyncapi/document-require-defaultcontenttype/