FAQ

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

    asyncapi-servers


    Formats: Severity:

    asyncapi-servers checks that the root servers object exists and contains at least one server definition.

    Why did this violation appear?

    The document has no root servers object, or the object is empty.

    Bad example

    asyncapi: 3.1.0
    info:
      title: User events
      version: 1.0.0
    channels: {}
    

    Good example

    asyncapi: 3.1.0
    info:
      title: User events
      version: 1.0.0
    servers:
      production:
        host: events.example.com
        protocol: mqtt
    channels: {}
    

    How do I fix this violation?

    Add at least one root server with a protocol and host appropriate for the event contract.