FAQ

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

    asyncapi-3-channel-no-empty-parameter


    Formats: Severity:

    asyncapi-3-channel-no-empty-parameter checks channel addresses for empty {} placeholders. Empty placeholders cannot be matched to a named channel parameter.

    Why did this violation appear?

    A channel address contains {} instead of a named parameter like {userId}.

    Bad example

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

    Good example

    asyncapi: 3.1.0
    channels:
      userEvents:
        address: users/{userId}/events
        parameters:
          userId:
            description: User identifier.
    

    How do I fix this violation?

    Name every placeholder and define a matching parameter for it on the channel.