Improve security decorator #78
Open
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
…y decorator, allowing it to work with the @Security decorator as currently defined in typescript-rest
… the swagger config file, when a named security parameter has not been provided
… breaking changes; minor version bump
|
This pull request has come as a result of the issue outlined originally by this issue: https://github.com/thiagobustamante/typescript-rest-swagger/issues/76 |
… explicitly named auth type that is used when the auth type has not been explicitly named
… (by throwing an error in the case of names, and defaulting to empty arrays in the case of scopes)
… nature of the names parameter properly
…efinitions in the actual defaults for proper testing)
|
@jackghicks if you want to fix the merge conflicts I'll take a look at this PR |
|
Anyone taking ownership on this PR? |
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.
Currently, the @Security decorator as defined in typescript-rest does not match the decorate as defined in typescript-rest-swagger.
This pull request adds support for the @Security decorator as defined in typescript-rest, without breaking support for the decorator as it stands, to maximize backwards compatibility.
Where no name is specified for the @Security decorator (in typescript-rest, this equates to roles(scopes) only) the contents of the swagger.config.json will be used to determine all appropriate matching securityDefinition entries, based on the scopes required.
Where the name is specified, the behavior is as it was before, albeit with some error checking now in place to ensure that the defined security rule matches something existing in the securityDefinitions. This could be construed as a breaking change, however for any users affected by this, their resulting swagger.yaml/json would have been invalid regardless.