close
The Wayback Machine - https://web.archive.org/web/20210504141108/https://github.com/github/docs/issues/5992
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

[Improvement]: Update REST API examples to use HTTP/2 instead of HTTP/1.1 #5992

Open
docs-bot opened this issue May 3, 2021 · 0 comments · May be fixed by #6002
Open

[Improvement]: Update REST API examples to use HTTP/2 instead of HTTP/1.1 #5992

docs-bot opened this issue May 3, 2021 · 0 comments · May be fixed by #6002

Comments

@docs-bot
Copy link
Collaborator

@docs-bot docs-bot commented May 3, 2021

What feature or product is affected?

REST API

What is the new or expected behavior?

use HTTP/2 instead of HTTP/1.1

How is the old or inaccurate behavior currently documented?

The REST API examples should use HTTP/2 instead of HTTP/1.1

For example, in this code snippet,

> HTTP/1.1 200 OK

would change to

> HTTP/2 200

Note: To compare HTTP2 vs HTTP1.1 responses, you can pass the -v option to curl: curl -i https://api.github.com -v --http1.1

Who does this affect?

users of the REST API

What is the impact to users?

confusion about differences between the API responses that the user sees and what the docs show

@docubot docubot added this to Help wanted in Docs team reviews May 3, 2021
@github-actions github-actions bot added the triage label May 3, 2021
@lucalves lucalves linked a pull request that will close this issue May 4, 2021
3 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants