fix: Improve handling of OpenAPI tag references #2325
Merged
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
Update `OpenApiTagComparer` to behave intuitively with `OpenApiTagReference` instances pointing to tags not defined in an `OpenApiDocument`. Contributes to microsoft#2319.
Verify OpenAPI tag references refer to a valid OpenAPI tag in the document on serialization. Resolves microsoft#2319.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+364
to
+370
| foreach (var tag in tags) | ||
| { | ||
| if (tag.Target is null) | ||
| { | ||
| throw new OpenApiException($"The OpenAPI tag reference '{tag.Reference.Id}' does reference a valid tag."); | ||
| } | ||
| } |
Check notice
Code scanning / CodeQL
Missed opportunity to use Where Note
bkoelman
reviewed
Apr 30, 2025
martincostello
added a commit
to martincostello/OpenAPI.NET
that referenced
this pull request
Apr 30, 2025
Fix typo in error message introduced by microsoft#2325.
Merged
MaggieKimani1
pushed a commit
that referenced
this pull request
Apr 30, 2025
Fix typo in error message introduced by #2325.
martincostello
added a commit
to domaindrivendev/Swashbuckle.AspNetCore
that referenced
this pull request
May 16, 2025
Fix tests due to error in test setup fixture caused by changes in microsoft/OpenAPI.NET#2325.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
OpenApiTagComparerto behave intuitively withOpenApiTagReferenceinstances pointing to tags not defined in anOpenApiDocument.Fixes #2319.