This repository was archived by the owner on Nov 1, 2017. It is now read-only.
User-Agent Example #263
Merged
User-Agent Example #263
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| All API requests MUST include a valid User Agent string. Requests with no User Agent | ||
| string will be rejected. If you are hitting the API without authentication, we ask that | ||
| All API requests MUST include a valid `User-Agent` header. Requests with no `User-Agent` | ||
| header will be rejected. If you are hitting the API without authentication, we ask that |
There was a problem hiding this comment.
I'd nuke the without authentication part. User-Agent became a requirement a while back.
There was a problem hiding this comment.
The user agent has nothing to do with authentication. That sentence is trying to ask anonymous spiders to set some descriptive user agent. For instance, search engines always identify themselves by name, instead of going by some vague default in whatever HTTP library they're using.
|
Okie - how about: |
|
👍 |
|
⚡ |
jlord
pushed a commit
that referenced
this pull request
Jun 12, 2013
hubot
pushed a commit
that referenced
this pull request
Nov 24, 2014
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was venturing into the wonderful world of the GitHub API tonight and was sent to this part of the docs through an error message I got about a User Agent. I found the docs a little confusing. From what I learned, the docs could be more clear by specifying that the user agent must be a header (it currently says string) and written like
user-agentsince it is a header and has to be hyphenated (it currently says User Agent). I also thought an example would be helpful as well. This PR makes little changes to this effect.Also, it says "All API requests MUST include" but then says "If you are hitting the API without authentication." If it MUST include something then how can you possibly be hitting the API without it? Maybe I'm just too much a n00b in the world of APIs but I thought it was worth mentioning.
Woo! 🐈