Skip to content

Update OpenAPI 3.1 Descriptions - #7428

Merged
github-actions[bot] merged 1 commit into
mainfrom
openapi-update-fa93184a3cd0f842b4f7c677750419ffb3b6de21d874f301b4d47d710bbb8e96
Nov 6, 2026
Merged

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

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 6, 2026 18:57

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 for the artifacts “retained versions” endpoint by adding pagination inputs and exposing pagination metadata in the response schema.

Changes:

  • Adds per_page and page query parameters to the endpoint.
  • Extends the 200-response schema with has_next_page and total_count fields (and examples).
  • Applies the same schema updates across current and date-pinned OpenAPI artifacts, including dereferenced variants.
File Description
descriptions-next/​api.github.com/​dereferenced/​api.github.com.deref.yaml Adds pagination params via anchors and adds has_next_page/total_count to response schema & examples.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.deref.json Inlines pagination params and adds has_next_page/total_count to response schema & examples.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2026-03-10.deref.yaml Same as above for the 2026-03-10 snapshot.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2026-03-10.deref.json Same as above for the 2026-03-10 snapshot (JSON deref).
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2022-11-28.deref.yaml Same as above for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​dereferenced/​api.github.com.2022-11-28.deref.json Same as above for the 2022-11-28 snapshot (JSON deref).
descriptions-next/​api.github.com/​api.github.com.yaml References shared per-page/page parameters and adds new response fields.
descriptions-next/​api.github.com/​api.github.com.json References shared per-page/page parameters and adds new response fields.
descriptions-next/​api.github.com/​api.github.com.2026-03-10.yaml Same changes for the 2026-03-10 snapshot.
descriptions-next/​api.github.com/​api.github.com.2026-03-10.json Same changes for the 2026-03-10 snapshot (JSON).
descriptions-next/​api.github.com/​api.github.com.2022-11-28.yaml Same changes for the 2022-11-28 snapshot.
descriptions-next/​api.github.com/​api.github.com.2022-11-28.json Same changes for the 2022-11-28 snapshot (JSON).

Review effort: Lite (auto)

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Automated change summary

Auto-merging 2e7f5f5, which changes these files:

 .../api.github.com/api.github.com.2022-11-28.json  | 21 +++++++++++++-
 .../api.github.com/api.github.com.2022-11-28.yaml  | 13 +++++++++
 .../api.github.com/api.github.com.2026-03-10.json  | 21 +++++++++++++-
 .../api.github.com/api.github.com.2026-03-10.yaml  | 13 +++++++++
 .../api.github.com/api.github.com.json             | 21 +++++++++++++-
 .../api.github.com/api.github.com.yaml             | 13 +++++++++
 .../api.github.com.2022-11-28.deref.json           | 33 +++++++++++++++++++++-
 .../api.github.com.2022-11-28.deref.yaml           | 13 +++++++++
 .../api.github.com.2026-03-10.deref.json           | 33 +++++++++++++++++++++-
 .../api.github.com.2026-03-10.deref.yaml           | 13 +++++++++
 .../dereferenced/api.github.com.deref.json         | 33 +++++++++++++++++++++-
 .../dereferenced/api.github.com.deref.yaml         | 13 +++++++++
 .../ghec/dereferenced/ghec.2022-11-28.deref.json   | 33 +++++++++++++++++++++-
 .../ghec/dereferenced/ghec.2022-11-28.deref.yaml   | 13 +++++++++
 .../ghec/dereferenced/ghec.2026-03-10.deref.json   | 33 +++++++++++++++++++++-
 .../ghec/dereferenced/ghec.2026-03-10.deref.yaml   | 13 +++++++++
 .../ghec/dereferenced/ghec.deref.json              | 33 +++++++++++++++++++++-
 .../ghec/dereferenced/ghec.deref.yaml              | 13 +++++++++
 descriptions-next/ghec/ghec.2022-11-28.json        | 21 +++++++++++++-
 descriptions-next/ghec/ghec.2022-11-28.yaml        | 13 +++++++++
 descriptions-next/ghec/ghec.2026-03-10.json        | 21 +++++++++++++-
 descriptions-next/ghec/ghec.2026-03-10.yaml        | 13 +++++++++
 descriptions-next/ghec/ghec.json                   | 21 +++++++++++++-
 descriptions-next/ghec/ghec.yaml                   | 13 +++++++++
 24 files changed, 468 insertions(+), 12 deletions(-)

Posted by the auto-merge workflow (run).

@github-actions
github-actions Bot merged commit 33ab5a9 into main Nov 6, 2026
6 of 7 checks passed
@github-actions
github-actions Bot deleted the openapi-update-fa93184a3cd0f842b4f7c677750419ffb3b6de21d874f301b4d47d710bbb8e96 branch November 6, 2026 20:26
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.

3 participants