Skip to content

Update OpenAPI 3.1 Descriptions - #7449

Merged
github-actions[bot] merged 1 commit into
mainfrom
openapi-update-7b81a9b9ef0381e05f39bdd1121b16265aef8a8690bbecb938465f2410ca0cb4
Nov 11, 2026
Merged

github-actions[bot] merged 1 commit into
mainfrom
openapi-update-7b81a9b9ef0381e05f39bdd1121b16265aef8a8690bbecb938465f2410ca0cb4

Conversation

@github-openapi-bot

Copy link
Copy Markdown
Collaborator

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

Copilot AI dynamic review requested due to automatic review settings November 11, 2026 16:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 document the new “issue planning status” field and a new issues-status-changed webhook event.

Changes:

  • Adds status (“Planning status”) to issue-related webhook payload schemas (nullable field on issues).
  • Introduces the issues-status-changed webhook endpoint and its webhook-issues-status-changed schema.
  • Regenerates dereferenced YAML and JSON artifacts for multiple versioned specs.
File Description
descriptions-next/​api.github.com/​dereferenced/​api.github.com.deref.yaml Adds status to dereferenced webhook issue payloads and includes the new webhook.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2026-03-10.deref.yaml Same updates as above for the 2026-03-10 snapshot.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2022-11-28.deref.yaml Same updates as above for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​api.github.com.yaml Adds issues-status-changed webhook + webhook-issues-status-changed schema; adds nullable issue status schema in components.
descriptions-next/​api.github.com/​api.github.com.json JSON equivalent of the webhook + schema additions.
descriptions-next/​api.github.com/​api.github.com.2026-03-10.yaml Same as api.github.com.yaml for the 2026-03-10 snapshot.
descriptions-next/​api.github.com/​api.github.com.2026-03-10.json JSON equivalent for the 2026-03-10 snapshot.
descriptions-next/​api.github.com/​api.github.com.2022-11-28.yaml Same as api.github.com.yaml for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​api.github.com.2022-11-28.json JSON equivalent for the 2022-11-28 snapshot.

Review effort: Lite (auto)

@github-actions

Copy link
Copy Markdown
Contributor

Automated change summary

Auto-merging 5692f37, which changes these files:

 .../api.github.com/api.github.com.2022-11-28.json  |  768 +++
 .../api.github.com/api.github.com.2022-11-28.yaml  |  652 ++
 .../api.github.com/api.github.com.2026-03-10.json  |  768 +++
 .../api.github.com/api.github.com.2026-03-10.yaml  |  652 ++
 .../api.github.com/api.github.com.json             |  768 +++
 .../api.github.com/api.github.com.yaml             |  652 ++
 .../api.github.com.2022-11-28.deref.json           | 7013 +++++++++++++++++--
 .../api.github.com.2022-11-28.deref.yaml           |  651 ++
 .../api.github.com.2026-03-10.deref.json           | 7001 +++++++++++++++++--
 .../api.github.com.2026-03-10.deref.yaml           |  651 ++
 .../dereferenced/api.github.com.deref.json         | 7038 ++++++++++++++++++--
 .../dereferenced/api.github.com.deref.yaml         |  651 ++
 .../ghec/dereferenced/ghec.2022-11-28.deref.json   | 7013 +++++++++++++++++--
 .../ghec/dereferenced/ghec.2022-11-28.deref.yaml   |  651 ++
 .../ghec/dereferenced/ghec.2026-03-10.deref.json   | 7001 +++++++++++++++++--
 .../ghec/dereferenced/ghec.2026-03-10.deref.yaml   |  651 ++
 .../ghec/dereferenced/ghec.deref.json              | 7038 ++++++++++++++++++--
 .../ghec/dereferenced/ghec.deref.yaml              |  651 ++
 descriptions-next/ghec/ghec.2022-11-28.json        |  768 +++
 descriptions-next/ghec/ghec.2022-11-28.yaml        |  652 ++
 descriptions-next/ghec/ghec.2026-03-10.json        |  768 +++
 descriptions-next/ghec/ghec.2026-03-10.yaml        |  652 ++
 descriptions-next/ghec/ghec.json                   |  768 +++
 descriptions-next/ghec/ghec.yaml                   |  652 ++
 .../dereferenced/ghes-3.19.2022-11-28.deref.json   |  666 ++
 .../dereferenced/ghes-3.19.2022-11-28.deref.yaml   |  465 ++
 .../ghes-3.19/dereferenced/ghes-3.19.deref.json    |  666 ++
 .../ghes-3.19/dereferenced/ghes-3.19.deref.yaml    |  465 ++
 .../ghes-3.19/ghes-3.19.2022-11-28.json            |  518 ++
 .../ghes-3.19/ghes-3.19.2022-11-28.yaml            |  460 ++
 descriptions-next/ghes-3.19/ghes-3.19.json         |  518 ++
 descriptions-next/ghes-3.19/ghes-3.19.yaml         |  460 ++
 .../dereferenced/ghes-3.20.2022-11-28.deref.json   |  666 ++
 .../dereferenced/ghes-3.20.2022-11-28.deref.yaml   |  465 ++
 .../ghes-3.20/dereferenced/ghes-3.20.deref.json    |  666 ++
 .../ghes-3.20/dereferenced/ghes-3.20.deref.yaml    |  465 ++
 .../ghes-3.20/ghes-3.20.2022-11-28.json            |  518 ++
 .../ghes-3.20/ghes-3.20.2022-11-28.yaml            |  460 ++
 descriptions-next/ghes-3.20/ghes-3.20.json         |  518 ++
 descriptions-next/ghes-3.20/ghes-3.20.yaml         |  460 ++
 .../dereferenced/ghes-3.21.2022-11-28.deref.json   |  666 ++
 .../dereferenced/ghes-3.21.2022-11-28.deref.yaml   |  465 ++
 .../dereferenced/ghes-3.21.2026-03-10.deref.json   |  666 ++
 .../dereferenced/ghes-3.21.2026-03-10.deref.yaml   |  465 ++
 .../ghes-3.21/dereferenced/ghes-3.21.deref.json    |  666 ++
 .../ghes-3.21/dereferenced/ghes-3.21.deref.yaml    |  465 ++
 .../ghes-3.21/ghes-3.21.2022-11-28.json            |  518 ++
 .../ghes-3.21/ghes-3.21.2022-11-28.yaml            |  460 ++
 .../ghes-3.21/ghes-3.21.2026-03-10.json            |  518 ++
 .../ghes-3.21/ghes-3.21.2026-03-10.yaml            |  460 ++
 descriptions-next/ghes-3.21/ghes-3.21.json         |  518 ++
 descriptions-next/ghes-3.21/ghes-3.21.yaml         |  460 ++
 .../dereferenced/ghes-3.22.2022-11-28.deref.json   |  666 ++
 .../dereferenced/ghes-3.22.2022-11-28.deref.yaml   |  465 ++
 .../dereferenced/ghes-3.22.2026-03-10.deref.json   |  666 ++
 .../dereferenced/ghes-3.22.2026-03-10.deref.yaml   |  465 ++
 .../ghes-3.22/dereferenced/ghes-3.22.deref.json    |  666 ++
 .../ghes-3.22/dereferenced/ghes-3.22.deref.yaml    |  465 ++
 .../ghes-3.22/ghes-3.22.2022-11-28.json            |  518 ++
 .../ghes-3.22/ghes-3.22.2022-11-28.yaml            |  460 ++
 .../ghes-3.22/ghes-3.22.2026-03-10.json            |  518 ++
 .../ghes-3.22/ghes-3.22.2026-03-10.yaml            |  460 ++
 descriptions-next/ghes-3.22/ghes-3.22.json         |  518 ++
 descriptions-next/ghes-3.22/ghes-3.22.yaml         |  460 ++
 64 files changed, 71426 insertions(+), 4194 deletions(-)

Posted by the auto-merge workflow (run).

@github-actions
github-actions Bot merged commit 5c36b6f into main Nov 11, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants