Updatesapi-github

GitHub REST API: 1 Breaking Change in Issues, Budgets

fc2c3bbd8e67 → 5aab7d2b5742Verified March 3, 2026

TL;DR

* The request body for the /repos/{owner}/{repo}/issues/{issue_number} endpoint has been removed, meaning clients can no longer send payload data when making requests to this specific route.

* Pagination is now supported for organization billing budgets via the newly added page query parameter, allowing you to navigate through large sets of budget data efficiently.

* You can now control the number of budget records returned per request using the per_page parameter on the /organizations/{org}/settings/billing/budgets endpoint.

* A new scope query parameter has been introduced for billing budgets, providing the ability to filter budget results based on specific organizational contexts.

* Developers maintaining integrations that interact with issue management or organization billing will need to update their API clients to accommodate these structural changes and take advantage of the new filtering capabilities.

What Changed

Breaking

* /repos/{owner}/{repo}/issues/{issue_number}: The request body has been completely removed from this endpoint. This change matters because any existing API calls sending a JSON payload here will be rejected by the server, requiring immediate removal of the payload from your client code to maintain functionality.

Feature

* /organizations/{org}/settings/billing/budgets: Added the page optional query parameter. This enables standard API pagination, preventing timeouts or excessive memory usage when retrieving extensive budget lists.

* /organizations/{org}/settings/billing/budgets: Added the per_page optional query parameter. This allows developers to define the page size, optimizing network payload size and client-side processing.

* /organizations/{org}/settings/billing/budgets: Added the scope optional query parameter. This permits filtering of the returned budgets to specific contexts, reducing the need for manual client-side data filtering.

Who's Impacted

* If you currently send a request body when interacting with the /repos/{owner}/{repo}/issues/{issue_number} endpoint, you will need to update your API client to remove this payload to prevent request errors.

* If you manage organization billing budgets and previously struggled with retrieving large datasets, you can now utilize the page, per_page, and scope parameters to paginate and filter your results.

Action Checklist

  • ☐ Audit your existing codebase for any network calls made to /repos/{owner}/{repo}/issues/{issue_number}.
  • ☐ Identify instances where a request body or JSON payload is being constructed for the issues endpoint.
  • ☐ Remove the request body payload from all identified issue endpoint calls.
  • ☐ Verify that the HTTP client configuration for the issues endpoint does not automatically append empty JSON objects.
  • ☐ Run unit tests related to issue retrieval or manipulation to ensure no payload-related errors occur.
  • ☐ Update internal API documentation or custom SDKs to reflect the removal of the issue request body.
  • ☐ Search the codebase for interactions with the /organizations/{org}/settings/billing/budgets endpoint.
  • ☐ Evaluate if current billing budget requests return too much data and could benefit from pagination.
  • ☐ Implement the page query parameter in your budget retrieval logic to handle multiple pages of data.
  • ☐ Add the per_page query parameter to optimize the size of the budget data payload returned.
  • ☐ Determine the optimal per_page value for your application's memory and performance constraints.
  • ☐ Assess whether your application needs to filter budgets by specific organizational contexts.
  • ☐ Integrate the new scope query parameter into your budget requests if filtering is required.
  • ☐ Update billing integration tests to verify pagination logic using the new page and per_page parameters.
  • ☐ Write new test cases to validate the filtering behavior of the scope parameter on the billing budgets endpoint.
  • ☐ Deploy updated API clients to staging environments for end-to-end testing.
  • ☐ Monitor production error logs for any malformed request errors related to the issues endpoint after deployment.

    • Verification

    * Sources:

    * [Commit 5aab7d2b5742](https://github.com/github/rest-api-description/commit/5aab7d2b5742f6ee12c9cb2428c8a1b7b8f26af4)

    * [GitHub REST API Spec Diff](https://github.com/github/rest-api-description/compare/fc2c3bbd8e67364c9ed84ae528b44ae0a6cc1672...5aab7d2b5742f6ee12c9cb2428c8a1b7b8f26af4)

    * Last Verified: 2026-03-03T22:06:16.165489+00:00

    📎 Sources