Repository navigation
Update OpenAPI 3.0 Descriptions - #7436
Merged
github-actions[bot] merged 1 commit intoNov 10, 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 GitHub OpenAPI 3.0 description examples to reflect current URL formats for user avatars and pull request API links.
Changes:
- Updated
avatar_urlexample values from legacysecure.gravatar.comURLs toavatars.githubusercontent.com. - Fixed malformed
pull_request.urlexample values fromhttps://api/github.com/...tohttps://api.github.com/.... - Applied the same example updates across the main, dereferenced, and date-stamped spec outputs (YAML + JSON).
| File | Description |
|---|---|
| descriptions/api.github.com/dereferenced/api.github.com.deref.yaml | Updates example avatar_url and corrects pull_request.url to the proper API domain. |
| descriptions/api.github.com/dereferenced/api.github.com.deref.json | Same example URL updates as the dereferenced YAML, in JSON form. |
| descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml | Propagates the example URL updates to the 2026-03-10 dereferenced YAML snapshot. |
| descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json | Propagates the example URL updates to the 2026-03-10 dereferenced JSON snapshot. |
| descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml | Propagates the example URL updates to the 2022-11-28 dereferenced YAML snapshot. |
| descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json | Propagates the example URL updates to the 2022-11-28 dereferenced JSON snapshot. |
| descriptions/api.github.com/api.github.com.yaml | Updates example URLs in the primary (non-dereferenced) YAML spec. |
| descriptions/api.github.com/api.github.com.json | Updates example URLs in the primary (non-dereferenced) JSON spec. |
| descriptions/api.github.com/api.github.com.2026-03-10.yaml | Applies example URL updates to the 2026-03-10 YAML snapshot. |
| descriptions/api.github.com/api.github.com.2026-03-10.json | Applies example URL updates to the 2026-03-10 JSON snapshot. |
| descriptions/api.github.com/api.github.com.2022-11-28.yaml | Applies example URL updates to the 2022-11-28 YAML snapshot. |
| descriptions/api.github.com/api.github.com.2022-11-28.json | Applies example URL updates to the 2022-11-28 JSON snapshot. |
Review effort: Lite (auto)
Contributor
Automated change summaryAuto-merging Posted by the auto-merge workflow (run). |
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.0 description with the latest changes. ✨