FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    asyncapi-3-payload-unsupported-schemaFormat


    Formats: Severity:

    asyncapi-3-payload-unsupported-schemaFormat reports messages that declare an explicit schemaFormat vacuum does not validate yet.

    Why did this violation appear?

    A message declares schemaFormat. Vacuum currently validates payload schema structure only when the message uses the default AsyncAPI schema format.

    Bad example

    asyncapi: 3.1.0
    components:
      messages:
        UserCreated:
          schemaFormat: application/vnd.apache.avro+json;version=1.9.0
          payload:
            type: record
    

    Good example

    asyncapi: 3.1.0
    components:
      messages:
        UserCreated:
          payload:
            type: object
            properties:
              id:
                type: string
    

    How do I fix this violation?

    Use the default schema format for payloads you want vacuum to validate today, or treat this informational result as a reminder that payload validation is not being applied.