diff --git a/CHANGELOG.md b/CHANGELOG.md index 66f56a1..d002794 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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: diff --git a/README.rst b/README.rst index 6ed4fdb..2174243 100644 --- a/README.rst +++ b/README.rst @@ -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 ============ @@ -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 diff --git a/src/ghreq/__init__.py b/src/ghreq/__init__.py index a478f70..64141c0 100644 --- a/src/ghreq/__init__.py +++ b/src/ghreq/__init__.py @@ -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 for more information. """ @@ -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" @@ -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"])