`user-agent-required` anchor is missing from getting-started-with-the-rest-api

[jsoref]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api#user-agent-required

What part(s) of the article would you like to see updated?

Add a section for user-agent-required

Additional information

For no particular reason, try running:

curl -A '' 'https://api.github.com/'

The output is:

Request forbidden by administrative rules. Please make sure your request has a User-Agent header (https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required). Check https://developer.github.com for other possible causes.

1. That first link doesn't yield an actual section in the docs.
2. The second link is strange, it feels like it's ~12 years stale and didn't get the memo about https://docs.github.com.

[Sharra-writes]

I feel like maybe it should be linking here? https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28#user-agent But I'm not sure we control those outputs, so it's possible this needs to go through support. Let me know if the section I linked seems like the correct information, at least.

[jsoref]

Either it should link there, or a subsection could be added to that so it's like:

User-Agent

All API requests must include a valid User-Agent header. The User-Agent header identifies the user or application that is making the request.

By default, GitHub CLI sends a valid User-Agent header. However, GitHub recommends using your GitHub username, or the name of your application, for the User-Agent header value. This allows GitHub to contact you if there are problems.

The following is an example User-Agent for an app named Awesome-Octocat-App:

User-Agent: Awesome-Octocat-App

User-Agent-Required

Requests with no User-Agent header will be rejected. If you provide an invalid User-Agent header, you will receive a 403 Forbidden response.

[evolvomind]

Hi, @jsoref
Is this issue resolved?
I would like to work on this one.

[jsoref]

It isn't resolved, however...
I'm pretty sure that GitHub staff (or a bot) rejects PRs to the rest directory tree.

[Sharra-writes]

@jsoref @evolvomind A lot of the REST API stuff is auto-generated and can't be updated manually, only through updating the schema, and the different operations belong to different teams. This is not one of those cases.

@jsoref, I think your proposed solution is the simplest, but breaks up the information unnecessarily from an article flow standpoint. Ideally, this should go through support, and they should change the link (and get rid of the developer.github.com link, because that's incredibly out of date). Would you hate checking with them to see if they'll figure it out? I'm willing to keep changing the article as a plan B if they aren't helpful.

[jsoref]

Opened https://support.github.com/ticket/personal/0/4060332

[Amnat-auyana1998]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api#user-agent-required

What part(s) of the article would you like to see updated?

Add a section for user-agent-required

Additional information

For no particular reason, try running:

curl -A '' 'https://api.github.com/'
The output is:

Request forbidden by administrative rules. Please make sure your request has a User-Agent header (https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required). Check https://developer.github.com for other possible causes.

1. That first link doesn't yield an actual section in the docs.
2. The second link is strange, it feels like it's ~12 years stale and didn't get the memo about https://docs.github.com.

[jsoref]

Fwiw, the response was:

I have escalated your report with our engineering team for further investigation.

[Sharra-writes]

@jsoref Thanks, keep me posted if you hear anything else.