FAQ

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

    asyncapi-3-channel-no-query-nor-fragment


    Formats: Severity:

    asyncapi-3-channel-no-query-nor-fragment keeps channel addresses focused on the addressable channel path or topic. Query strings and fragments do not belong in AsyncAPI channel addresses.

    Why did this violation appear?

    A channel address contains ? or #.

    Bad example

    asyncapi: 3.1.0
    channels:
      userEvents:
        address: users/{userId}/events?debug=true
    

    Good example

    asyncapi: 3.1.0
    channels:
      userEvents:
        address: users/{userId}/events
    

    How do I fix this violation?

    Remove query strings and fragments from the channel address. Model filtering, routing hints, or broker-specific behavior somewhere explicit instead of encoding it into the address.