Skip to content

Update OpenAPI 3.1 Descriptions - #7461

Merged
github-actions[bot] merged 1 commit into
mainfrom
openapi-update-2755f0724e12d72cc10b8da47d1498bdaa21c3c11ca98ac5c0e7e2e22637bd9d
Nov 12, 2026
Merged

github-actions[bot] merged 1 commit into
mainfrom
openapi-update-2755f0724e12d72cc10b8da47d1498bdaa21c3c11ca98ac5c0e7e2e22637bd9d

Conversation

@github-openapi-bot

Copy link
Copy Markdown
Collaborator

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

Copilot AI auto review requested due to automatic review settings November 12, 2026 19:21

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/spec artifacts to reflect recent API changes across the “current” and versioned (2022-11-28, 2026-03-10) specifications.

Changes:

  • Adds/updates issue field and issue type example properties (e.g., visibility, option metadata, color, is_enabled).
  • Normalizes/moves some schema and response description fields (e.g., secret scanning “first detected location”, workflow dispatch response).
  • Simplifies repeated “planning status” id descriptions by removing the rename-stability sentence.
File Description
descriptions-next/​api.github.com/​dereferenced/​api.github.com.deref.json Updates dereferenced JSON with new issue field/type attributes and repositions some schema descriptions.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2026-03-10.deref.yaml Mirrors updates in dereferenced YAML for the 2026-03-10 snapshot (issue fields/types, schema description placement, migration properties).
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2026-03-10.deref.json Mirrors updates in dereferenced JSON for the 2026-03-10 snapshot, including migration schema property ordering.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2022-11-28.deref.yaml Mirrors updates in dereferenced YAML for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2022-11-28.deref.json Mirrors updates in dereferenced JSON for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​api.github.com.yaml Applies the spec changes in the primary YAML OpenAPI document (issue field/type examples, secret scanning schema description placement, planning status description edits).
descriptions-next/​api.github.com/​api.github.com.json Applies the same spec changes in the primary JSON OpenAPI document.
descriptions-next/​api.github.com/​api.github.com.2026-03-10.yaml Applies the same changes to the versioned 2026-03-10 YAML OpenAPI document (plus workflow dispatch response description placement, migration schema property ordering).
descriptions-next/​api.github.com/​api.github.com.2026-03-10.json Applies the same changes to the versioned 2026-03-10 JSON OpenAPI document.
descriptions-next/​api.github.com/​api.github.com.2022-11-28.yaml Applies the same changes to the versioned 2022-11-28 YAML OpenAPI document.
descriptions-next/​api.github.com/​api.github.com.2022-11-28.json Applies the same changes to the versioned 2022-11-28 JSON OpenAPI document.

Review effort: Lite (auto)

@github-actions

Copy link
Copy Markdown
Contributor

Automated change summary

Auto-merging 713ce65, which changes these files:

 .../api.github.com/api.github.com.2022-11-28.json  | 100 +++-
 .../api.github.com/api.github.com.2022-11-28.yaml  |  98 ++--
 .../api.github.com/api.github.com.2026-03-10.json  | 118 ++--
 .../api.github.com/api.github.com.2026-03-10.yaml  | 112 ++--
 .../api.github.com/api.github.com.json             | 100 +++-
 .../api.github.com/api.github.com.yaml             |  98 ++--
 .../api.github.com.2022-11-28.deref.json           | 200 +++++--
 .../api.github.com.2022-11-28.deref.yaml           |  68 ++-
 .../api.github.com.2026-03-10.deref.json           | 636 +++++++++++---------
 .../api.github.com.2026-03-10.deref.yaml           |  80 ++-
 .../dereferenced/api.github.com.deref.json         | 200 +++++--
 .../dereferenced/api.github.com.deref.yaml         |  68 ++-
 .../ghec/dereferenced/ghec.2022-11-28.deref.json   | 204 +++++--
 .../ghec/dereferenced/ghec.2022-11-28.deref.yaml   |  68 ++-
 .../ghec/dereferenced/ghec.2026-03-10.deref.json   | 640 ++++++++++++---------
 .../ghec/dereferenced/ghec.2026-03-10.deref.yaml   |  80 ++-
 .../ghec/dereferenced/ghec.deref.json              | 204 +++++--
 .../ghec/dereferenced/ghec.deref.yaml              |  68 ++-
 descriptions-next/ghec/ghec.2022-11-28.json        | 100 +++-
 descriptions-next/ghec/ghec.2022-11-28.yaml        |  98 ++--
 descriptions-next/ghec/ghec.2026-03-10.json        | 118 ++--
 descriptions-next/ghec/ghec.2026-03-10.yaml        | 112 ++--
 descriptions-next/ghec/ghec.json                   | 100 +++-
 descriptions-next/ghec/ghec.yaml                   |  98 ++--
 .../dereferenced/ghes-3.19.2022-11-28.deref.json   | 208 +++----
 .../dereferenced/ghes-3.19.2022-11-28.deref.yaml   |  70 +--
 .../ghes-3.19/dereferenced/ghes-3.19.deref.json    | 208 +++----
 .../ghes-3.19/dereferenced/ghes-3.19.deref.yaml    |  70 +--
 .../ghes-3.19/ghes-3.19.2022-11-28.json            | 112 ++--
 .../ghes-3.19/ghes-3.19.2022-11-28.yaml            |  98 ++--
 descriptions-next/ghes-3.19/ghes-3.19.json         | 112 ++--
 descriptions-next/ghes-3.19/ghes-3.19.yaml         |  98 ++--
 .../dereferenced/ghes-3.20.2022-11-28.deref.json   | 240 ++++----
 .../dereferenced/ghes-3.20.2022-11-28.deref.yaml   |  72 +--
 .../ghes-3.20/dereferenced/ghes-3.20.deref.json    | 240 ++++----
 .../ghes-3.20/dereferenced/ghes-3.20.deref.yaml    |  72 +--
 .../ghes-3.20/ghes-3.20.2022-11-28.json            | 118 ++--
 .../ghes-3.20/ghes-3.20.2022-11-28.yaml            | 102 ++--
 descriptions-next/ghes-3.20/ghes-3.20.json         | 118 ++--
 descriptions-next/ghes-3.20/ghes-3.20.yaml         | 102 ++--
 .../dereferenced/ghes-3.21.2022-11-28.deref.json   |  76 +--
 .../dereferenced/ghes-3.21.2022-11-28.deref.yaml   |  32 +-
 .../dereferenced/ghes-3.21.2026-03-10.deref.json   | 440 +++++++-------
 .../dereferenced/ghes-3.21.2026-03-10.deref.yaml   |  44 +-
 .../ghes-3.21/dereferenced/ghes-3.21.deref.json    |  76 +--
 .../ghes-3.21/dereferenced/ghes-3.21.deref.yaml    |  32 +-
 .../ghes-3.21/ghes-3.21.2022-11-28.json            |  42 +-
 .../ghes-3.21/ghes-3.21.2022-11-28.yaml            |  62 +-
 .../ghes-3.21/ghes-3.21.2026-03-10.json            |  60 +-
 .../ghes-3.21/ghes-3.21.2026-03-10.yaml            |  76 +--
 descriptions-next/ghes-3.21/ghes-3.21.json         |  42 +-
 descriptions-next/ghes-3.21/ghes-3.21.yaml         |  62 +-
 .../dereferenced/ghes-3.22.2022-11-28.deref.json   |  76 +--
 .../dereferenced/ghes-3.22.2022-11-28.deref.yaml   |  32 +-
 .../dereferenced/ghes-3.22.2026-03-10.deref.json   | 440 +++++++-------
 .../dereferenced/ghes-3.22.2026-03-10.deref.yaml   |  44 +-
 .../ghes-3.22/dereferenced/ghes-3.22.deref.json    |  76 +--
 .../ghes-3.22/dereferenced/ghes-3.22.deref.yaml    |  32 +-
 .../ghes-3.22/ghes-3.22.2022-11-28.json            |  42 +-
 .../ghes-3.22/ghes-3.22.2022-11-28.yaml            |  62 +-
 .../ghes-3.22/ghes-3.22.2026-03-10.json            |  60 +-
 .../ghes-3.22/ghes-3.22.2026-03-10.yaml            |  76 +--
 descriptions-next/ghes-3.22/ghes-3.22.json         |  42 +-
 descriptions-next/ghes-3.22/ghes-3.22.yaml         |  62 +-
 64 files changed, 4300 insertions(+), 3596 deletions(-)

Posted by the auto-merge workflow (run).

@github-actions
github-actions Bot merged commit bd6df26 into main Nov 12, 2026
6 of 7 checks passed
@github-actions
github-actions Bot deleted the openapi-update-2755f0724e12d72cc10b8da47d1498bdaa21c3c11ca98ac5c0e7e2e22637bd9d branch November 12, 2026 20:27
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