Skip to content

Update default X-GitHub-Api-Version to 2026-03-10 #26

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
jwodder merged 1 commit into from
Jun 20, 2026
Merged

Update default X-GitHub-Api-Version to 2026-03-10 #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
v0.8.0 (in development)
-----------------------
- Updated the default value of the ``X-GitHub-Api-Version`` header to
"2026-03-10", up from "2022-11-28". See `the GitHub documentation`__ for
information on breaking changes in the new API version.

__ https://docs.github.com/en/rest/about-the-rest-api/breaking-changes#version-2026-03-10


v0.7.0 (2025-11-28)
-------------------
- Support for making GraphQL requests to custom URLs:
Expand Down
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ aimed at working with the GitHub REST API. Notable features include:

.. _requests: https://requests.readthedocs.io

__ https://docs.github.com/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api?#handle-rate-limit-errors-appropriately
__ https://docs.github.com/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api#handle-rate-limit-errors-appropriately

Installation
============
Expand Down Expand Up @@ -498,7 +498,7 @@ The default value of the ``api_url`` argument to the ``Client`` constructor

.. code:: python

DEFAULT_API_VERSION = "2022-11-28"
DEFAULT_API_VERSION = "2026-03-10"

The default value of the ``api_version`` argument to the ``Client`` constructor

Expand Down
9 changes: 5 additions & 4 deletions src/ghreq/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@

.. _requests: https://requests.readthedocs.io

__ https://docs.github.com/en/rest/guides/best-practices-for-using-the-rest-api
?apiVersion=2022-11-28#dealing-with-rate-limits
__ https://docs.github.com/en/rest/using-the-rest-api
/best-practices-for-using-the-rest-api
#handle-rate-limit-errors-appropriately

Visit <https://github.com/jwodder/ghreq> for more information.
"""
Expand All @@ -49,7 +50,7 @@
from typing import TYPE_CHECKING, Any, Literal, overload
import requests

__version__ = "0.7.0"
__version__ = "0.8.0.dev1"
__author__ = "John Thorvald Wodder II"
__author_email__ = "ghreq@varonathe.org"
__license__ = "MIT"
Expand Down Expand Up @@ -78,7 +79,7 @@

#: The default value of the ``api_version`` argument to the `Client`
#: constructor
DEFAULT_API_VERSION = "2022-11-28"
DEFAULT_API_VERSION = "2026-03-10"

MUTATING_METHODS = frozenset(["POST", "PATCH", "PUT", "DELETE"])

Expand Down