Repository navigation
Update OpenAPI 3.1 Descriptions - #7461
Merged
github-actions[bot] merged 1 commit intoNov 12, 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/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
descriptionfields (e.g., secret scanning “first detected location”, workflow dispatch response). - Simplifies repeated “planning status”
iddescriptions 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)
Contributor
Automated change summaryAuto-merging Posted by the auto-merge workflow (run). |
github-actions
Bot
deleted the
openapi-update-2755f0724e12d72cc10b8da47d1498bdaa21c3c11ca98ac5c0e7e2e22637bd9d
branch
November 12, 2026 20:27
This was referenced Nov 12, 2026
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. ✨