FAQ

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

    asyncapi-message-examples


    Formats: Severity:

    asyncapi-message-examples checks that message examples contain something a reader can inspect.

    Why did this violation appear?

    A message example exists but defines neither payload nor headers.

    Bad example

    asyncapi: 3.1.0
    components:
      messages:
        UserCreated:
          examples:
            - name: empty-example
    

    Good example

    asyncapi: 3.1.0
    components:
      messages:
        UserCreated:
          examples:
            - name: created-user
              payload:
                id: usr_123
    

    How do I fix this violation?

    Add a payload or headers object to every message example, or remove empty placeholder examples.