Comment to keep API preview headers around #2188
Merged
Conversation
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
These media types will be added to the API request as headers and used to enable particular features on GitHub API that are still in preview. After some time, specific media types will be promoted (to a "stable" state). From then on, the preview headers are not required anymore to activate the additional feature on GitHub.com's API. However, this API header might still be needed for users to run a GitHub Enterprise Server on-premise. It's not uncommon for GitHub Enterprise Server customers to run older versions which would probably rely on the preview headers for some time. While the header promotion is going out for GitHub.com, it may be some time before it even arrives in GitHub Enterprise Server. We keep those preview headers around to avoid breaking older GitHub Enterprise Server versions. Additionally, an non-functional (preview) header doesn't create any side effects on GitHub Cloud version. See #2125 for full context.
google-cla
bot
added
the
cla: yes
Codecov Report
@@ Coverage Diff @@
## master #2188 +/- ##
=======================================
Coverage 97.78% 97.78%
=======================================
Files 112 112
Lines 9970 9976 +6
=======================================
+ Hits 9749 9755 +6
Misses 154 154
Partials 67 67
Continue to review full report at Codecov.
|
gmlewis
requested changes
Oct 31, 2021
Collaborator
gmlewis
left a comment
gmlewis
left a comment
There was a problem hiding this comment.
Thank you, @andygrunwald !
Just a couple tiny nits, then LGTM and can be merged.
Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
Contributor
Author
|
Thanks for the quick review @gmlewis. |
gmlewis
approved these changes
Oct 31, 2021
Collaborator
gmlewis
left a comment
gmlewis
left a comment
There was a problem hiding this comment.
Thank you, @andygrunwald !
LGTM.
Merging.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What type of PR is this?
documentation
What this PR does / why we need it:
API preview headers (media types) are used to enable new features in GitHub API.
These media types will be added to the API request as headers and used to enable particular features on GitHub API that are still in preview.
After some time, specific media types will be promoted (to a "stable" state).
From then on, the preview headers are not required anymore to activate the additional feature on GitHub.com's API. However, this API header might still be needed for users to run a GitHub Enterprise Server on-premise.
It's not uncommon for GitHub Enterprise Server customers to run older versions which would probably rely on the preview headers for some time.
While the header promotion is going out for GitHub.com, it may be some time before it even arrives in GitHub Enterprise Server.
We keep those preview headers around to avoid breaking older GitHub Enterprise Server versions. Additionally, an non-functional (preview) header doesn't create any side effects on GitHub Cloud version.
See #2125 for full context.
Special notes for your reviewer:
This Pull Request was triggered out of a discussion from #2125
Explicit comment
Personally, I prefer and see value in extensive comments that tell the story and the full context next to the code (like in this PR).
I can understand when this interrupts the code reading flow for others.
I do think that the added advantage (by the additional context) is bigger.
Please let me know what you think about it and if any change is required.
Additional documentation, usage docs, etc.: