search

hapijs / jwt

JWT (JSON Web Token) Authentication
Other
36 stars 25 forks source link

Add API.md #12

Closed keerthivasan-r closed 4 years ago

keerthivasan-r commented 4 years ago

Please review and let me know your view. This closes #7

damusix commented 4 years ago

This is lacking quite a bit but is a good starting point. Missing how to create tokens, explanations about plugin options schemas, the different ways to fetch keys (in server jwt, off server jwks), etc. There's a lot more to this plugin that just setting up a validate function. Look at the tests, there's way more to cover.

keerthivasan-r commented 4 years ago

Yes, you are right. But, I just wanted to cover the details enough to kick start with it. we can cover all the details, you mentioned as we move on. Thanks for the feedback. I think we can improve it incrementally. Cheers

damusix commented 4 years ago

@keerthivasan-r Agreed. I can add more if we can get a merge in @jarrodyellets

damusix commented 4 years ago

Perhaps merge into a docs branch so it doesn't get picked up by the website until you consider it ready?