asyncapi / asyncapi/spec

Incorrect kafka example (should not be valid)

Open
#1,164 5 comments 0 reactions 0 assignees View on GitHub
🐞 Bug
Dominant language
JavaScript
Stars
5.3k
Forks
382
Avg merge
7m
Merged PRs (30d)
4

Description

### Describe the bug

This example has x- fields in bindings.

https://github.com/asyncapi/spec/blob/master/examples/adeo-kafka-request-reply-asyncapi.yml

But according to docs they are should not exist there, so example is not valid and should be removed.

https://github.com/asyncapi/bindings/blob/master/kafka/README.md
https://github.com/asyncapi/spec-json-schemas/tree/master/bindings/kafka/0.5.0

Contributor guide

Open the contributing guide

Research direction

Start with examples/adeo-kafka-request-reply-asyncapi.yml and compare its bindings with the Kafka binding README and the 0.5.0 schema linked in the issue. Confirm that the x- fields are not valid there, then remove the invalid example and verify it is no longer present.

Written by the indexing model from the issue text.

Assessment

Tech stack
kafka
Domain
documentation
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.