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

feat: add config options to override pub sub label text #632

Merged
merged 3 commits into from
Sep 8, 2022

Conversation

BTOdell
Copy link

@BTOdell BTOdell commented Aug 19, 2022

Updated documentation. All tests pass. Not sure how I would go about adding new tests for this feature...

Description

Changes proposed in this pull request:

  • Provide two new config properties for overriding the default "PUB" and "SUB" operation label text.

Reason for feature

At my company, Megh Computing Inc, we are using AsyncAPI to document our WebSocket API. Our API does not operate in a typical PUB-SUB way; clients do not "publish" data to the endpoints. Any data sent to an endpoint is to configure that WebSocket session and specify the async events that the client wishes to receive. We have received feedback from our customers that the terminology label "PUB" is confusing. Our solution is to rename the "PUB" label to "CONF", but the tool currently does not support overriding that label text.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.

Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! @BTOdell Sorry for such a delay and thanks for the contribution!

@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 8, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@magicmatatjahu
Copy link
Member

/rtm

@magicmatatjahu magicmatatjahu merged commit ae3c628 into asyncapi:next Sep 8, 2022
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.0.0-next.41 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants