-
-
Notifications
You must be signed in to change notification settings - Fork 380
Description
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:
- Open the AsyncAPI 3.0 specification repository.
- Navigate to the
examples/directory. - Inspect a message example (for example, Kafka or AMQP examples).
- 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.