dherault / serverless-offline

Emulate AWS λ and API Gateway locally when developing your Serverless project
MIT License
5.19k stars 796 forks source link

doc: Fix customAuthenticationProvider documentation #1683

Closed petetnt closed 11 months ago

petetnt commented 1 year ago

Description

This PR fixes the description for enabling custom authentication providers in serverless.yml files. In addition to using the correct keys, I added an usage example and direct linked the referenced integration test example.

Related to #1311

Motivation and Context

The documentation was wrong and hard to follow. Correct solution was pointed out in https://github.com/dherault/serverless-offline/issues/1311#issuecomment-1176860248 by @rion18.

How Has This Been Tested?

Implemented the custom provider in my own project. Additionally I tested that the key serverless-offline and authenticationProvider mentioned in the README are no-ops and that the implementation in https://github.com/dherault/serverless-offline/tree/master/tests/integration/custom-authentication is in fact correct.

dnalborczyk commented 11 months ago

thank you @petetnt