chore: apply proper type to each @ApiQuery decorator in the API contr… #311
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
3 tasks
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.
Hi!
The hosted OpenAPI spec that is abstracted from the
@ApiPropertydecorators using@nestjs/swaggeris missing certain types. This is easy to check by simply opening the OpenAPI spec and checking the very first method and it's input parameters.The schema type the input parameter
addressis set to{}- this causes request client generators like OpenAPI generator to interpret the parameter as an object, rather than the desired string.To mitigate this, I simply added the
typeproperty in every@ApiQuerydecorator instance, which should lead to proper output in the OpenAPI spec.Let me know if you would like to see any changes here.