docs/api: note API clients may send charset parameter in Content-Type header
#5778
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
Since at least commit 099adaa in 2013 the Git LFS client has included a "charset=utf-8" parameter in some or all of the Content-Type headers it sends to server API endpoints. As noted in git-lfs#5775, we do not at present mention this parameter in our API documentation, and the "charset" parameter is not required by any IETF RFCs for MIME types other than "text/*" types, so we note that servers should be prepared to accept this header parameter but that it is not required. h/t KalleOlaviNiemitalo for the suggestion
bk2204
approved these changes
Jun 7, 2024
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.
Since at least commit 099adaa in 2013 the Git LFS client has included a
charset=utf-8parameter in some or all of theContent-Typeheaders it sends to server API endpoints.As noted in #5775, we do not at present mention this parameter in our API documentation, and the
charsetparameter is not required by any IETF RFCs for MIME types other thantext/*types, so we update our documentation to mention that servers should be prepared to accept this header parameter but that it is not required.Thanks to @KalleOlaviNiemitalo for the suggestion!