AsyncAPI Best Practices

general > asyncapi-payload-unsupported-schemaFormat

Guidance

AsyncAPI can support various schemaFormat values. When unspecified, one of the following will be assumed:

application/vnd.aai.asyncapi;version=2.0.0 application/vnd.aai.asyncapi+json;version=2.0.0

application/vnd.aai.asyncapi+yaml;version=2.0.0

Message

The schemaFormat value '{{apiContract.schemaMediaType}}' is not supported by AsyncAPI.

Examples

valid

channels:
  myChannel:
    publish:
      message:
        payload:
          type: object
          properties:
            myProperty:
              type: string
        schemaFormat: "application/vnd.aai.asyncapi+json;version=2.0.0"

invalid

channels:
  myChannel:
    publish:
      message:
        payload:
          type: object
          properties:
            myProperty:
              type: string
        schemaFormat: "application/somerandomschema;version=2.0.0"

Applies to Payload

Constraint

Type: Declarative Validation