Merge pull request #82 from per1234/recommended-request-headers

Use all recommended headers in GitHub API HTTP requests

Author: per1234

reportsizedeltas/reportsizedeltas.py

@@ -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

reportsizedeltas/tests/test_reportsizedeltas.py

@@ -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()