fix(event-handler): operation tags are now string to correct schema generation #3528
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
pull-request-size
bot
added
the
size/S
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #3528 +/- ##
===========================================
- Coverage 95.78% 95.70% -0.09%
===========================================
Files 210 210
Lines 9681 9681
Branches 1774 1773 -1
===========================================
- Hits 9273 9265 -8
- Misses 294 298 +4
- Partials 114 118 +4 ☔ View full report in Codecov by Sentry. |
heitorlessa
reviewed
Dec 18, 2023
heitorlessa
approved these changes
Dec 18, 2023
heitorlessa
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue number: #3520
Summary
Changes
This PR fixes an issue with spec compliance when generating operation tags.
User experience
Before this PR, our OpenAPI generation was generating opeation tags as dictionaries, similar to the Tag Object. However, in the context of an Operation, this is wrong, as tags should just be a list of strings.
This was causing any OpenAPI schema validation to fail. This PR fixes this.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.