-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Description
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.mdfile. -
[]
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
jwtauthentication 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
AuthenticationStrategyinterface, and theextensionPoint/extensions pattern, howcustom authentication strategies can be registered, how acustom sequencemust be created, and howcontroller methods must be decoratedin 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