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

Token documentation inaccurate #34

Open
Marston opened this issue May 17, 2021 · 2 comments
Open

Token documentation inaccurate #34

Marston opened this issue May 17, 2021 · 2 comments

Comments

@Marston
Copy link

Marston commented May 17, 2021

It turns out the user can use their .netrc file to pass in the CMR token. There is no clear examples in the Readme and it is hard to find out the examples, which were inaccurate on how to pass the token into the config dictionary.
As it currently stand, the user should use car-token instead of the standard: Authorization as the dictionary key.
Please fix this to use the standard dictionary language for Bearer tokens and provide simple examples of the use of this powerful API.

@jceaser
Copy link
Contributor

jceaser commented May 18, 2021

The .netrc example is not to be included in the documentation, but the readme does not show how to use tokens requiring users to go to the notebooks to see examples.

Three changes should be done here:

  1. add a short token example to the readme, and point to the notebook for further examples
  2. update the token code to return a bearer token so that users do not have to do this on their own.
  3. move code off of Echo-Token header and to Authorization header.

@jceaser
Copy link
Contributor

jceaser commented May 18, 2021

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

No branches or pull requests

2 participants