Skip to content

Use all recommended headers in GitHub API HTTP requests #82

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 24, 2024
Merged

Use all recommended headers in GitHub API HTTP requests #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52c3d5f
Add "Accept" header to GitHub API HTTP requests
per1234 Jan 24, 2024
272dfea
Use recommended form for "Authorization" header in GitHub API requests
per1234 Jan 24, 2024
01f5811
Pin GitHub REST API version in requests
per1234 Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions reportsizedeltas/reportsizedeltas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,13 @@ def raw_http_request(self, url: str, data: bytes | None = None):

logger.info("Opening URL: " + url)

# GitHub recommends using user name as User-Agent (https://developer.github.com/v3/#user-agent-required)
headers = {"Authorization": "token " + self.token, "User-Agent": self.repository_name.split("/")[0]}
headers = {
"Accept": "application/vnd.github+json",
"Authorization": "Bearer " + self.token,
# GitHub recommends using user name as User-Agent (https://developer.github.com/v3/#user-agent-required)
"User-Agent": self.repository_name.split("/")[0],
"X-GitHub-Api-Version": "2022-11-28",
}
request = urllib.request.Request(url=url, headers=headers, data=data)

retry_count = 0
Expand Down
9 changes: 8 additions & 1 deletion reportsizedeltas/tests/test_reportsizedeltas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,14 @@ def test_raw_http_request(mocker):
report_size_deltas.raw_http_request(url=url, data=data)

urllib.request.Request.assert_called_once_with(
url=url, headers={"Authorization": "token " + token, "User-Agent": user_name}, data=data
url=url,
headers={
"Accept": "application/vnd.github+json",
"Authorization": "Bearer " + token,
"User-Agent": user_name,
"X-GitHub-Api-Version": "2022-11-28",
},
data=data,
)
# URL is subject to GitHub API rate limiting
report_size_deltas.handle_rate_limiting.assert_called_once()
Expand Down