Skip to content

🐞 Bug: Example message schemas in AsyncAPI 3.0 spec missing required fields #1174

@wei123-web

Description

@wei123-web

Describe the bug

Some example message schemas in the AsyncAPI 3.0 specification do not include all required fields defined in their corresponding component schemas. This makes the examples invalid and may confuse developers who rely on them for correct implementation.

To Reproduce

Steps to reproduce the behavior:

  1. Open the AsyncAPI 3.0 specification repository.
  2. Navigate to the examples/ directory.
  3. Inspect a message example (for example, Kafka or AMQP examples).
  4. Compare the example fields with the required fields defined in components/schemas.

Expected behavior

All example message schemas should include every required field defined in their corresponding schema definitions.

Sample document

N/A – issue observed directly in the AsyncAPI 3.0 spec examples.

Screenshots

N/A – screenshots can be added if a specific example is requested.

Additional context

This issue affects developers who use the AsyncAPI spec examples as references and may lead to incorrect or invalid implementations. I am happy to contribute a fix by updating the examples if needed.

In the AsyncAPI 3.0.0 specification, some schema examples are not rendered or resolved correctly in the documentation. While the first example is displayed as expected, the other examples do not show their schema structure and appear unresolved or missing in the rendered output. This creates confusion for users trying to understand how multiple schema examples should be defined and used.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions