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

Updating the ReadMe(documentation) for the structure of JSON after successful parsing of Access Token #13

Open
asingh04 opened this issue May 4, 2022 · 4 comments
Labels
enhancement New feature or request

Comments

@asingh04
Copy link

asingh04 commented May 4, 2022

Describe the feature request?

Not exactly a feature request, but request to update the documentation.
In the documentation:

If the access token is valid it will be converted to a JSON object and returned to your code.

However there is no mention of the structure or properties of the returned JSON and what data it will hold.
It would be helpful for developers using this library to know what is being returned

New or Affected Resource(s)

Documentation (ReadMe)

Provide a documentation link

https://github.com/okta/okta-jwt-verifier-js/blob/master/README.md

Additional Information?

No response

@asingh04 asingh04 added the enhancement New feature or request label May 4, 2022
@oleksandrpravosudko-okta
Copy link
Contributor

Thanks for reaching out @asingh04.
This package contains typings for verifyAccessToken return value - is this something you could use?

@asingh04
Copy link
Author

asingh04 commented May 9, 2022

@oleksandrpravosudko-okta
Most of people, like me, might be using this library on a pure JS project. So the only way to look into it would be running the script and using debuggers/console.logs to see what is being returned.

Also not sure, but a little description/example in the documentation helps a lot before implementing or using the function.

@asingh04
Copy link
Author

asingh04 commented May 9, 2022

@oleksandrpravosudko-okta i would be happy to write the description & raise a PR for it. :)

@oleksandrpravosudko-okta
Copy link
Contributor

Thanks @asingh04, we will update the description.
Internal ref: OKTA-498763

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants