chore(): v8 major release WIP #1395
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
set default value for the status code in ApiResponse decorator if status code not pass.
Currently the schemas are passed around with two variables:
- `schemas` of type Array<{[key: string]: SchemaObject>`
- `schemasRefPaths` which lists the keys
There are a few issues:
- `schemas` is wrongly typed as `SchemaObject[]` in the code
- Two related arguments need to be passed to many function accepting schemas
- To check if an item is already in `schemas`, `schemasRefPaths.includes(key)` is used
which is O(schemas.length)
- It is not clear that `schemasRefPaths` is actually used to avoid
infinite recursion.
This commit uses only one variable, `schemas`. To avoid infinite
recursion, `schemasRefPaths` is used only where necessary as an
internal variable, and is renamed to `pendingSchemaRefs`. It is also
passed by copy when modified, so that it's restored to its previous value once the recursive call is ended.
Lookup is now fast: O(1) when looking up `schemas`, and when avoiding
infinite recursion `pendingPaths` is looked up as well but it is a short
array that does not contain any more elements than needed.
Typing is also fixed.
This plugin alreday supported nullables, but it failed to handle them properly for both Optional types and Unions with null types.
Ensure that the paths property comes before the components property, as this may lead to several strange display bugs in swagger-ui. See swagger-api/swagger-ui#5972 or swagger-api/swagger-ui#3325 (comment) Closes #1369
…-by-reversing-order-of-document-properties fix(@nestjs/swagger) Change created document property order
fix(plugin): allow the use of "uiConfig" options to fastify-swagger and Swagger UI
fix(plugin): Handle nullable properties
…rator fix: set default status for api-response decorator
fix(@nestjs/swagger): Fix generated types for single string literals
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?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information