Skip to content
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

Add API.md #12

Merged
merged 2 commits into from Aug 22, 2020
Merged

Add API.md #12

merged 2 commits into from Aug 22, 2020

Conversation

keerthivasan-r
Copy link
Contributor

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

@damusix
Copy link
Contributor

damusix commented Aug 1, 2020

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
Copy link
Contributor Author

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
Copy link
Contributor

damusix commented Aug 1, 2020

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

@damusix
Copy link
Contributor

damusix commented Aug 2, 2020

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

@lloydbenson lloydbenson self-assigned this Aug 22, 2020
@lloydbenson lloydbenson self-requested a review August 22, 2020 20:50
Copy link
Contributor

@lloydbenson lloydbenson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks like a good initial start and hopefully this merge helps encourage you to write more! We really appreciate your contribution.

@lloydbenson lloydbenson merged commit ebc7b1a into hapijs:master Aug 22, 2020
@cjihrig cjihrig added this to the 2.0.1 milestone Sep 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing API file
4 participants