Skip to content

API documentation: Fixing space new header line bug#25026

Merged
skedwards88 merged 1 commit intogithub:mainfrom
joshjohanning:joshjohanning/patch-app-slashes
Apr 20, 2023
Merged

API documentation: Fixing space new header line bug#25026
skedwards88 merged 1 commit intogithub:mainfrom
joshjohanning:joshjohanning/patch-app-slashes

Conversation

@joshjohanning
Copy link
Contributor

Why:

Before the line to add the API version header, the \ to signify a new line doesn't have a space after the previous header, so the request fails.

The doc page:
image

the error message:
image

{
"message": "A JSON web token could not be decoded",
"documentation_url": "https://docs.github.com/rest"
}
curl: (3) URL using bad/illegal format or missing URL

Adding a space works:
image

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adding a space in several spots in the docs where it is missing before the date/version header.

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

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

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
rest/guides/getting-started-with-the-rest-api.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
rest/overview/authenticating-to-the-rest-api.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
rest/overview/resources-in-the-rest-api.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@joshjohanning Thanks so much for opening a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. github apps Content related to GitHub Apps and removed triage Do not begin working on this issue until triaged by the team labels Apr 20, 2023
Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

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

🚀 Thank you for noticing and fixing this! We'll get this merged down for you.

@skedwards88 skedwards88 added this pull request to the merge queue Apr 20, 2023
@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Apr 20, 2023
Merged via the queue into github:main with commit 6e7d14d Apr 20, 2023
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

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 github apps Content related to GitHub Apps ready to merge This pull request is ready to merge rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants