Fix/Feat: Support header-based versioning and filtering routes by version #3209
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
…Options interface Add optional property `includeVersions` to the SwaggerDocumentOptions interface so users can filter the generated OpenAPI specification and resulting Swagger UI down to routes matching a specific version or subset of versions rather than including all versions as is the default behavior.
aarongoin
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
npm run format)What is the current behavior?
Currently
@nestjs/waggerdoes not support header-based versioning that is documented as being supported here: https://docs.nestjs.com/techniques/versioning#header-versioning-typeIn addition end users lack any ability to filter the routes documented in the OpenAPI specification down to some subset of versions their app supports.
Issue Number: #2990
What is the new behavior?
Apps that use header-based versioning for endpoints (and I believe media-type based versioning as well though I haven't tested) are now properly supported. Endpoints of different versions using the same path no longer conflict with each other and are documented as separate endpoints in the resulting OpenAPI specification.
Additionally users can filter the endpoints documented down to a subset to better support use cases where there is a separate swagger document per API version.
Does this PR introduce a breaking change?
Other information