Fix default tag logic for paths #1002
Merged
Conversation
This file contains 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
The default tag for paths is resolved from the module path of the handler or `OpenApi` if the type in question is a nested `OpenApi` document. This was supposed to be only the case when no additional tags are provided for the paths. However it was resolved in all cases and there was no way to "not to use" module path as a tag. This commit fixes this and the module path will be only used if there are no other tags defined. This commit also changes the old behavior where _`crate`_ was used as a tag in case there was no module path available. From now on if there is no module path there will be no default tag added to any of the paths. This will result the paths to be rendered under _`default`_ tag in a Swagger UI. Fixes #978
This pull request was closed.
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.
The default tag for paths is resolved from the module path of the handler or
OpenApiif the type in question is a nestedOpenApidocument. This was supposed to be only the case when no additional tags are provided for the paths. However it was resolved in all cases and there was no way to "not to use" module path as a tag. This commit fixes this and the module path will be only used if there are no other tags defined.This commit also changes the old behavior where
cratewas used as a tag in case there was no module path available. From now on if there is no module path there will be no default tag added to any of the paths. This will result the paths to be rendered underdefaulttag in a Swagger UI.Fixes #978 Fixes #955