docs: auth decorator with multiple strategies #6142
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
raymondfeng
reviewed
Aug 18, 2020
| @@ -73,7 +83,7 @@ export class WhoAmIController { | |||
| An example of the decorator when options **are** specified looks like this: | |||
|
|
|||
| ```ts | |||
| @authenticate('basic', { /* some options for the strategy */}) | |||
| @authenticate({'basic', { /* some options for the strategy */}}) | |||
There was a problem hiding this comment.
{name: 'basic', options: { /* some options for the strategy */ }}
jannyHou
force-pushed
the
docs/auth-update
branch
2 times, most recently
from
cde66ee to
67ce05c
Compare
dhmlau
reviewed
Aug 19, 2020
| ```ts | ||
| @authenticate(metadata: AuthenticationMetadata) | ||
| ``` | ||
| - single strategy: `@authenticate(strategyName)` |
There was a problem hiding this comment.
Maybe we can group the single strategy with and without options together? likewise for the multiple strategies?
There was a problem hiding this comment.
thanks @dhmlau changed.
raymondfeng
approved these changes
Aug 19, 2020
Signed-off-by: jannyHou <[email protected]>
jannyHou
force-pushed
the
docs/auth-update
branch
from
67ce05c to
a5fc169
Compare
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.
Update auth decorator docs to include multiple strategies.
This adds docs for PR #5735
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈