-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update @loopback\authentication documentation #2940
Comments
@emonddr Thank you for creating the doc issue, for the 4 tasks in the acceptance criteria: 1 - I agree 👍 |
we can either have 2 separate examples showing separate custom authentication strategies or we can have 1 |
Other LoopBack4 documents which will need to be revised:
|
@raymondfeng what is the |
@emonddr, let's limit the scope of this task to be the core authentication documentation, and open a separate task for updating other docs pages that involve authentication. We can better groom that new task over there too. Thanks. |
Please see checkbox:
Let's discuss how we can change this image. thx. |
Description / Steps to reproduce / Feature proposal
The REAME.md of the @loopback/authentication module needs to be updated
to discuss the new authentication architecture.
Current Behavior
Shows an authentication example that makes use of npm modules : passport passport-http and the old strategy adapter.
Expected Behavior
Explain more of the architecture of the authentication module (not specific implementations of strategies), and provide links to examples which provide ready-to-run applications and detailed explanations of implementations.
Acceptance Criteria
Remove information that is not applicable or not relevant in the current
authentication/README.md
file.[]
Re-work https://github.com/strongloop/loopback-next/blob/master/packages/authentication/docs/authentication-system.md into standalone pages for Application and Extension developers on loopback.io.Create tutorial on enabling
jwt
authentication with shopping cart example.Show how to set up basic authentication in the docs and point to the above tutorial.
If we can showcase basic authentication strategy in the README without too much information, then we can include some code snippets there. Otherwise point to docs.document briefly discusses the
AuthenticationStrategy
interface, and theextensionPoint/extensions pattern
, howcustom authentication strategies can be registered
, how acustom sequence
must be created, and howcontroller methods must be decorated
in order to authenticate endpoints in a LoopBack application.(I don't see the point in going into a lot of step by step details if we are providing a link to examples whose README.md files will go into details). Include basic usage as well.See Reporting Issues for more tips on writing good issues
The text was updated successfully, but these errors were encountered: