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

The cURL code samples in the API docs have a typo in the Authorization Header line #26708

Closed
1 task done
WhiteFruit opened this issue Jul 14, 2023 · 2 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@WhiteFruit
Copy link

Code of Conduct

What article on docs.github.com is affected?

Seemingly all instances of cURL code samples in the API docs include the below typo. I have only spot-checked, but tracking the source of the issue leads me to believe all instances would have the same problem.

Screenshot 2023-07-14 at 10 30 13 AM

If you copy/paste that full command (replacing the necessary variables "<YOUR-TOKEN>", "OWNER", and "REPO" with valid values), you will get a cURL error:

curl: (3) URL using bad/illegal format or missing URL
{
  "message": "Bad credentials",
  "documentation_url": "https://docs.github.com/rest"
}

What changes are you suggesting?

The authorization header line in the cURL code samples should have a space before the backslash escape character at the end of the line:
-H "Authorization: Bearer <YOUR-TOKEN>"\ should be -H "Authorization: Bearer <YOUR-TOKEN>" \

Screenshot 2023-07-14 at 10 30 52 AM

I opened PR #26706 to address this, but the file is restricted since it's in the src directory.

Additional information

No response

@WhiteFruit WhiteFruit added the content This issue or pull request belongs to the Docs Content team label Jul 14, 2023
@welcome
Copy link

welcome bot commented Jul 14, 2023

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 14, 2023
@cmwilson21
Copy link
Contributor

@WhiteFruit Thanks for opening an issue! As you stated, we don't accept changes to those files in that repo. We had a similar issue reported recently that I transferred over to the /rest-api-description repo, so I'm going to go ahead and add this issue there, as well. Here's the link to it.

I'm going to go ahead and close this issue. But thanks for opening and for your interest in improving the docs! 💖

@cmwilson21 cmwilson21 removed the triage Do not begin working on this issue until triaged by the team label Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

No branches or pull requests

3 participants
@WhiteFruit @cmwilson21 and others