Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs Bug 🐞 report]: Different brokers in Adding Security page #3567

Open
1 task done
HARDY8118 opened this issue Jan 12, 2025 · 1 comment · May be fixed by #3568
Open
1 task done

[Docs Bug 🐞 report]: Different brokers in Adding Security page #3567

HARDY8118 opened this issue Jan 12, 2025 · 1 comment · May be fixed by #3568

Comments

@HARDY8118
Copy link

Describe the bug you found in AsyncAPI Docs.

In the Adding Security page, the protocol mentioned in the example is amqp however the following text reads

The example above shows how to specify that your server (a Kafka broker) requires a user and a password to establish a connection.

The protocol mentioned (amqp) is not supported by Kafka and hence one of the following changes are suggested

  • The example should be changed to have kafka in protocol, OR
  • The following text should mention some other message queue which supports AMQP (something like RabbitMQ)

Since the description (and the host) mention broker, I believe the intentions of the publisher was originally to mention amqp and hence the text should be changed.

Let me know of your thoughts. 🙂

Attach any resources that can help us understand the issue.

image
image

Code of Conduct

  • I agree to follow this project's Code of Conduct
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@HARDY8118 HARDY8118 linked a pull request Jan 12, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant