docs: add operation tags to AsyncAPI test specification #443
+519
−61
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added tags to publish and subscribe operations in test/asyncapi.yaml to improve API documentation and organization. Also added generated/ to .gitignore to prevent committing generated code.
aditya4044656
requested review from
anandsunderraman,
asyncapi-bot-eve and
smoya
as code owners
![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 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.
Author
|
Hello @smoya@anandsunderraman👋 I’ve opened this pull request to improve the AsyncAPI test specification by Could someone please review this when you have time? |
- Add v3 compatibility layer in components/common.js - getAsyncAPIVersion() to detect spec version - hasPublishCompat() and hasSubscribeCompat() for v2/v3 operations - getPublishOperationCompat() and getSubscribeOperationCompat() helpers - Update all handler functions to accept asyncapi parameter - SubscriptionHandlers, PublishHandlers, Imports, Handlers - publishConfigsFrom now uses compatibility functions - Update template files to pass asyncapi parameter - template/asyncapi/handlers.js - template/index.js - Update package.json generator version to support v3 (>=1.3.0 <3.0.0) - Add v3 test specifications - test/files/docWithAMQPublisherV3.yml (receive operations) - test/files/docWithAMQPSubscriberV3.yml (send operations) - Add v3 test cases (commented out - require parser v3 upgrade) - Tests will be enabled when @asyncapi/parser is upgraded to v3.x - Fix GetProtocolFlags() to handle channels with bindings but no operations - Add .golangci.yml to exclude vendor directories from linting BREAKING CHANGE: None - Full backward compatibility with v2 maintained Closes #954
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request improves the AsyncAPI test specification by adding explicit
operation tags and improving repository hygiene. The goal is to make the
specification easier to understand, better organized, and aligned with
AsyncAPI best practices.
Changes
measurementoperation tag to publish and subscribe operations intest/asyncapi.yamlmeasurementtag definition with a clear description.gitignoreto exclude thegenerated/directory to preventaccidental commits of auto-generated files
Motivation
Operation tags help categorize and group AsyncAPI operations, making the
documentation easier to navigate and improving clarity for contributors and
tooling. Excluding generated files ensures a cleaner repository and avoids
unintentional changes to generated output.
Type of Change
Additional Notes
Thank you for reviewing this contribution. Feedback and suggestions are very
welcome.