feat: add essential Kafka client security config #447
Conversation
This commit updates the HTML generated by the react template so that it includes essential Kafka config required for clients. This makes it easier for someone using HTML docs generated from AsyncAPI docs to get started creating a Kafka client. Signed-off-by: Dale Lane <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. 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.
|
inspired by a discussion on Slack similar to a pull request I created for markdown-template |
|
Example output: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka
description: Test brokerresults in this from
|
|
Example output: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka-secure
description: Test brokerresults in this from
|
|
Example output: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka-secure
description: Test broker
security:
- saslScram: []
components:
securitySchemes:
saslScram:
type: scramSha256
description: create credentials in the dev portalresults in this from
|
There was a problem hiding this comment.
@dalelane Thanks for contribution! I'm not an expert in security and thanks for rendering it the way it needs to be. For 2.1 I just rendered new security types, so thank you!
Please refer to my suggestions, overall good, but we can improve some parts :)
Signed-off-by: Dale Lane <[email protected]>
Styling improvement requested in review Co-authored-by: Maciej Urbańczyk <[email protected]>
|
Thanks for the review! I've added commits to address the bits you caught. |
There was a problem hiding this comment.
LGTM! Thanks for contribution!
@dalelane Sorry, we have a problem 😅 Could you run lint npm run lint:fix to fix linter errors and push changes? While pushing the suggestions I forgot that there might be a problem with the linter. And sorry for the delay with the second review.
Signed-off-by: Dale Lane <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
|
@all-contributors please add @dalelane for code, ideas |
|
I've put up a pull request to add @dalelane! 🎉 |
|
🎉 This PR is included in version 1.0.0-next.21 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This commit updates the HTML generated by the react template
so that it includes essential Kafka config required for clients.
This makes it easier for someone using HTML docs generated from
AsyncAPI docs to get started creating a Kafka client.
Signed-off-by: Dale Lane [email protected]