docs: injection of current user may require optional set to true #3185
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
emonddr
requested review from
jannyHou,
nabdelgadir and
agnes512
and removed request for
raymondfeng and
bajtos
nabdelgadir
approved these changes
Jun 19, 2019
agnes512
reviewed
Jun 19, 2019
| @@ -40,5 +40,8 @@ export class WhoAmIController { | |||
| } | |||
| ``` | |||
|
|
|||
| {% include note.html content="If only <b>some</b> of the controller methods are decorated with the <b>@authenticate</b> decorator, then the injection decorator for CURRENT_USER in the controller's constructor must be specified as <b>@inject(AuthenticationBindings.CURRENT_USER, {optional:true})</b> to avoid a binding error when an unauthenticated endpoint is accessed. Alternatively, do not inject CURRENT_USER in the controller <b>constructor</b>, but in the controller <b>methods</b> which are actually decorated with the <b>@authenticate</b> decorator. See [Method Injection](../Dependency-injection.md#method-injection), [Constructor Injection](../Dependency-injection.md#constructor-injection) and [Optional Dependencies](../Dependency-injection.md#optional-dependencies) for details. | |||
| " %} | |||
There was a problem hiding this comment.
I don't know if you need the double quotation here for the markdown file
There was a problem hiding this comment.
Hi Agnes,
I followed the LoopBack documentation concerning documentation : tips, alerts, notes etc
https://loopback.io/doc/en/contrib/alerts.html
They use ".
But yes in javascript, ' can be used in place of " in most situations.
There was a problem hiding this comment.
I think the double quotation is necessary, since content=" begins with one.
agnes512
approved these changes
Jun 19, 2019
LGTM
Optional flag may need to be set to true when injecting CURRENT_USER in a controller constructor if only some controller methods are decorated with the @authenticate decorator
emonddr
force-pushed
the
dremond_docs_auth_optional_current_user
branch
from
6b36185 to
549e7ca
Compare
delete-merged-branch
bot
deleted the
dremond_docs_auth_optional_current_user
branch
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.
Optional flag may need to be set to true when injecting
CURRENT_USER in a controller constructor if only
some controller methods are decorated with the
@authenticate decorator
Related to : #2940
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 👈