FAQ

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

    asyncapi-3-document-resolved


    Formats: Severity:

    asyncapi-3-document-resolved validates the fully resolved AsyncAPI 3 document graph. It catches document build problems after references have been followed, so broken references surface as lint results instead of hidden parser failures.

    Why did this violation appear?

    The document contains a structure or reference that cannot be resolved into a valid AsyncAPI 3 document.

    Bad example

    asyncapi: 3.1.0
    info:
      title: Broken events
      version: 1.0.0
    channels:
      userEvents:
        address: users
        messages:
          - $ref: '#/components/messages/MissingMessage'
    components:
      messages: {}
    

    Good example

    asyncapi: 3.1.0
    info:
      title: User events
      version: 1.0.0
    channels:
      userEvents:
        address: users
        messages:
          - $ref: '#/components/messages/UserCreated'
    components:
      messages:
        UserCreated:
          payload:
            type: object
    

    How do I fix this violation?

    Fix broken references and invalid objects so the resolved document can be built. Start with the path reported by vacuum, then check the referenced component exists and is valid.