Repository navigation
Update OpenAPI 3.1 Descriptions - #7428
Merged
github-actions[bot] merged 1 commit intoNov 6, 2026
Merged
github-actions[bot] merged 1 commit into
github-actions[bot] merged 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
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_pageandpagequery parameters to the endpoint. - Extends the 200-response schema with
has_next_pageandtotal_countfields (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)
biolumince
approved these changes
Nov 6, 2026
biolumince
approved these changes
Nov 6, 2026
Contributor
Automated change summaryAuto-merging Posted by the auto-merge workflow (run). |
github-actions
Bot
deleted the
openapi-update-fa93184a3cd0f842b4f7c677750419ffb3b6de21d874f301b4d47d710bbb8e96
branch
November 6, 2026 20:26
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
👋 humans. This PR updates the OpenAPI 3.1 description with the latest changes. ✨