Repository navigation
Update OpenAPI 3.1 Descriptions - #7417
Open
github-openapi-bot wants to merge 1 commit into
Open
github-openapi-bot wants to merge 1 commit into
github-openapi-bot wants to merge 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 to reflect recent REST API behavior and authorization documentation changes, including additional notification filtering and updated Copilot cloud agent access requirements.
Changes:
- Add an
is_doneboolean query parameter to notification listing endpoints. - Update Copilot cloud agent organization endpoints’ descriptions to reflect custom org roles and adjust required scopes from
admin:orgtoread:org. - Propagate these updates across versioned and dereferenced JSON/YAML artifacts.
| File | Description |
|---|---|
| descriptions-next/api.github.com/dereferenced/api.github.com.deref.json | Adds is_done parameter and updates Copilot endpoint descriptions in dereferenced JSON. |
| descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml | Adds is_done parameter and updates Copilot description/scope in dereferenced YAML (2026-03-10). |
| descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json | Adds is_done parameter and updates Copilot description/scope in dereferenced JSON (2026-03-10). |
| descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml | Adds is_done parameter and updates Copilot description/scope in dereferenced YAML (2022-11-28). |
| descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json | Adds is_done parameter and updates Copilot description/scope in dereferenced JSON (2022-11-28). |
| descriptions-next/api.github.com/api.github.com.yaml | Adds is_done to canonical OpenAPI YAML paths and updates Copilot descriptions/scope. |
| descriptions-next/api.github.com/api.github.com.json | Mirrors canonical changes in OpenAPI JSON. |
| descriptions-next/api.github.com/api.github.com.2026-03-10.yaml | Applies canonical changes to the 2026-03-10 versioned YAML. |
| descriptions-next/api.github.com/api.github.com.2026-03-10.json | Applies canonical changes to the 2026-03-10 versioned JSON. |
| descriptions-next/api.github.com/api.github.com.2022-11-28.yaml | Applies canonical changes to the 2022-11-28 versioned YAML. |
| descriptions-next/api.github.com/api.github.com.2022-11-28.json | Applies canonical changes to the 2022-11-28 versioned JSON. |
Review effort: Lite (auto)
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. ✨