Update OpenAPI 3.1 Descriptions by github-openapi-bot · Pull Request #7417 · github/rest-api-description

github-openapi-bot · 2026-11-04T19:45:00Z

👋 humans. This PR updates the OpenAPI 3.1 description with the latest changes. ✨

Copilot

Note

Copilot was unable to run its full agentic suite in this review.

Copilot review overview

No open issues 🎉

What changed in this PR

Updates the OpenAPI 3.1 descriptions to reflect recent REST API behavior and authorization documentation changes, including additional notification filtering and updated Copilot cloud agent access requirements.

Changes:

Add an is_done boolean query parameter to notification listing endpoints.
Update Copilot cloud agent organization endpoints’ descriptions to reflect custom org roles and adjust required scopes from admin:org to read:org.
Propagate these updates across versioned and dereferenced JSON/YAML artifacts.

File	Description
descriptions-next/api.github.com/dereferenced/api.github.com.deref.json	Adds `is_done` parameter and updates Copilot endpoint descriptions in dereferenced JSON.
descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml	Adds `is_done` parameter and updates Copilot description/scope in dereferenced YAML (2026-03-10).
descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json	Adds `is_done` parameter and updates Copilot description/scope in dereferenced JSON (2026-03-10).
descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml	Adds `is_done` parameter and updates Copilot description/scope in dereferenced YAML (2022-11-28).
descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json	Adds `is_done` parameter and updates Copilot description/scope in dereferenced JSON (2022-11-28).
descriptions-next/api.github.com/api.github.com.yaml	Adds `is_done` to canonical OpenAPI YAML paths and updates Copilot descriptions/scope.
descriptions-next/api.github.com/api.github.com.json	Mirrors canonical changes in OpenAPI JSON.
descriptions-next/api.github.com/api.github.com.2026-03-10.yaml	Applies canonical changes to the 2026-03-10 versioned YAML.
descriptions-next/api.github.com/api.github.com.2026-03-10.json	Applies canonical changes to the 2026-03-10 versioned JSON.
descriptions-next/api.github.com/api.github.com.2022-11-28.yaml	Applies canonical changes to the 2022-11-28 versioned YAML.
descriptions-next/api.github.com/api.github.com.2022-11-28.json	Applies canonical changes to the 2022-11-28 versioned JSON.

_{Review effort: Lite (auto)}

github-actions · 2026-11-04T20:26:23Z

Automated change summary

Auto-merging 627ec1a, which changes these files:

 .../api.github.com/api.github.com.2022-11-28.json  | 22 +++++++++++--
 .../api.github.com/api.github.com.2022-11-28.yaml  | 37 ++++++++++++++++++----
 .../api.github.com/api.github.com.2026-03-10.json  | 22 +++++++++++--
 .../api.github.com/api.github.com.2026-03-10.yaml  | 37 ++++++++++++++++++----
 .../api.github.com/api.github.com.json             | 22 +++++++++++--
 .../api.github.com/api.github.com.yaml             | 37 ++++++++++++++++++----
 .../api.github.com.2022-11-28.deref.json           | 22 +++++++++++--
 .../api.github.com.2022-11-28.deref.yaml           | 37 ++++++++++++++++++----
 .../api.github.com.2026-03-10.deref.json           | 22 +++++++++++--
 .../api.github.com.2026-03-10.deref.yaml           | 37 ++++++++++++++++++----
 .../dereferenced/api.github.com.deref.json         | 22 +++++++++++--
 .../dereferenced/api.github.com.deref.yaml         | 37 ++++++++++++++++++----
 .../ghec/dereferenced/ghec.2022-11-28.deref.json   | 22 +++++++++++--
 .../ghec/dereferenced/ghec.2022-11-28.deref.yaml   | 37 ++++++++++++++++++----
 .../ghec/dereferenced/ghec.2026-03-10.deref.json   | 22 +++++++++++--
 .../ghec/dereferenced/ghec.2026-03-10.deref.yaml   | 37 ++++++++++++++++++----
 .../ghec/dereferenced/ghec.deref.json              | 22 +++++++++++--
 .../ghec/dereferenced/ghec.deref.yaml              | 37 ++++++++++++++++++----
 descriptions-next/ghec/ghec.2022-11-28.json        | 22 +++++++++++--
 descriptions-next/ghec/ghec.2022-11-28.yaml        | 37 ++++++++++++++++++----
 descriptions-next/ghec/ghec.2026-03-10.json        | 22 +++++++++++--
 descriptions-next/ghec/ghec.2026-03-10.yaml        | 37 ++++++++++++++++++----
 descriptions-next/ghec/ghec.json                   | 22 +++++++++++--
 descriptions-next/ghec/ghec.yaml                   | 37 ++++++++++++++++++----
 .../dereferenced/ghes-3.19.2022-11-28.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.19.2022-11-28.deref.yaml   | 20 ++++++++++++
 .../ghes-3.19/dereferenced/ghes-3.19.deref.json    | 18 +++++++++++
 .../ghes-3.19/dereferenced/ghes-3.19.deref.yaml    | 20 ++++++++++++
 .../ghes-3.19/ghes-3.19.2022-11-28.json            | 18 +++++++++++
 .../ghes-3.19/ghes-3.19.2022-11-28.yaml            | 20 ++++++++++++
 descriptions-next/ghes-3.19/ghes-3.19.json         | 18 +++++++++++
 descriptions-next/ghes-3.19/ghes-3.19.yaml         | 20 ++++++++++++
 .../dereferenced/ghes-3.20.2022-11-28.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.20.2022-11-28.deref.yaml   | 20 ++++++++++++
 .../ghes-3.20/dereferenced/ghes-3.20.deref.json    | 18 +++++++++++
 .../ghes-3.20/dereferenced/ghes-3.20.deref.yaml    | 20 ++++++++++++
 .../ghes-3.20/ghes-3.20.2022-11-28.json            | 18 +++++++++++
 .../ghes-3.20/ghes-3.20.2022-11-28.yaml            | 20 ++++++++++++
 descriptions-next/ghes-3.20/ghes-3.20.json         | 18 +++++++++++
 descriptions-next/ghes-3.20/ghes-3.20.yaml         | 20 ++++++++++++
 .../dereferenced/ghes-3.21.2022-11-28.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.21.2022-11-28.deref.yaml   | 20 ++++++++++++
 .../dereferenced/ghes-3.21.2026-03-10.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.21.2026-03-10.deref.yaml   | 20 ++++++++++++
 .../ghes-3.21/dereferenced/ghes-3.21.deref.json    | 18 +++++++++++
 .../ghes-3.21/dereferenced/ghes-3.21.deref.yaml    | 20 ++++++++++++
 .../ghes-3.21/ghes-3.21.2022-11-28.json            | 18 +++++++++++
 .../ghes-3.21/ghes-3.21.2022-11-28.yaml            | 20 ++++++++++++
 .../ghes-3.21/ghes-3.21.2026-03-10.json            | 18 +++++++++++
 .../ghes-3.21/ghes-3.21.2026-03-10.yaml            | 20 ++++++++++++
 descriptions-next/ghes-3.21/ghes-3.21.json         | 18 +++++++++++
 descriptions-next/ghes-3.21/ghes-3.21.yaml         | 20 ++++++++++++
 .../dereferenced/ghes-3.22.2022-11-28.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.22.2022-11-28.deref.yaml   | 20 ++++++++++++
 .../dereferenced/ghes-3.22.2026-03-10.deref.json   | 18 +++++++++++
 .../dereferenced/ghes-3.22.2026-03-10.deref.yaml   | 20 ++++++++++++
 .../ghes-3.22/dereferenced/ghes-3.22.deref.json    | 18 +++++++++++
 .../ghes-3.22/dereferenced/ghes-3.22.deref.yaml    | 20 ++++++++++++
 .../ghes-3.22/ghes-3.22.2022-11-28.json            | 18 +++++++++++
 .../ghes-3.22/ghes-3.22.2022-11-28.yaml            | 20 ++++++++++++
 .../ghes-3.22/ghes-3.22.2026-03-10.json            | 18 +++++++++++
 .../ghes-3.22/ghes-3.22.2026-03-10.yaml            | 20 ++++++++++++
 descriptions-next/ghes-3.22/ghes-3.22.json         | 18 +++++++++++
 descriptions-next/ghes-3.22/ghes-3.22.yaml         | 20 ++++++++++++
 64 files changed, 1372 insertions(+), 96 deletions(-)

Posted by the auto-merge workflow (run).

Update OpenAPI 3.1 Descriptions

627ec1a

Copilot AI dynamic review requested due to automatic review settings November 4, 2026 19:45

Copilot AI reviewed Nov 4, 2026

View reviewed changes

github-actions Bot merged commit 8726703 into main Nov 4, 2026
6 of 7 checks passed

github-actions Bot deleted the openapi-update-e0e1175fddbff7927d41227b59b2317e22448e42286616d994b976e6e96202cd branch November 4, 2026 20:26

This was referenced Nov 4, 2026

Update OpenAPI 3.0 Descriptions #7414

Closed

Update OpenAPI 3.1 Descriptions #7415

Closed

Navigation Menu

Repository navigation

Update OpenAPI 3.1 Descriptions - #7417

Update OpenAPI 3.1 Descriptions#7417
github-actions[bot] merged 1 commit into
mainfrom
openapi-update-e0e1175fddbff7927d41227b59b2317e22448e42286616d994b976e6e96202cd

github-openapi-bot commented Nov 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Nov 4, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

github-openapi-bot commented Nov 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

github-actions Bot commented Nov 4, 2026

Automated change summary

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants