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

fix(docs): refer to Authorization header in the README, not Authentication #418

Merged
merged 1 commit into from
Oct 19, 2022

Conversation

ptabor
Copy link
Contributor

@ptabor ptabor commented Oct 19, 2022

The correct name of the header is 'Authorization' and not 'Authentication'.

Tested with:

curl -H "Authorization: bearer {edited}" -X POST -d " \
 { \
   \"query\": \"query { viewer { login }}\" \
 } \
" https://api.github.com/graphql

Previously:

$ curl -H "Authentication: bearer {edited}" -X POST -d " \
 { \
   \"query\": \"query { viewer { login }}\" \
 } \
" https://api.github.com/graphql
{
  "message": "This endpoint requires you to be authenticated.",
  "documentation_url": "https://docs.github.com/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql"
}

The correct name of the header is 'Authorization' and not 'Authentication'. 

Tested with: 

```
curl -H "Authorization: bearer {edited}" -X POST -d " \
 { \
   \"query\": \"query { viewer { login }}\" \
 } \
" https://api.github.com/graphql
```

Previously:
```
$ curl -H "Authentication: bearer {edited}" -X POST -d " \
 { \
   \"query\": \"query { viewer { login }}\" \
 } \
" https://api.github.com/graphql
{
  "message": "This endpoint requires you to be authenticated.",
  "documentation_url": "https://docs.github.com/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql"
}
```
@timrogers timrogers changed the title Update README.md: Authentication -> Authorization header. fix(docs): refer to Authorization header in the README, not Authentication Oct 19, 2022
Copy link

@timrogers timrogers left a comment

Choose a reason for hiding this comment

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

Great spot! Thanks for fixing this ❤️

@timrogers timrogers added Type: Bug Something isn't working as documented Type: Documentation Improvements or additions to documentation labels Oct 19, 2022
@timrogers timrogers merged commit f4e8019 into octokit:master Oct 19, 2022
@github-actions
Copy link

🎉 This PR is included in version 5.0.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants