Skip to content

Commit a29c53f

Browse files
committed
docs/api: note charset parameter may be sent
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
1 parent 41612f7 commit a29c53f

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

docs/api/basic-transfers.md

+3
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,7 @@ Git LFS clients send:
141141
< HTTP/1.1 200 OK
142142
```
143143

144+
The client may also include a `charset=utf-8` parameter in the
145+
`Content-Type` header, which servers should be prepared to accept.
146+
144147
A 200 response means that the object exists on the server.

docs/api/batch.md

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ headers. The request and response bodies are JSON.
1919
Accept: application/vnd.git-lfs+json
2020
Content-Type: application/vnd.git-lfs+json
2121

22+
The client may also include a `charset=utf-8` parameter in the
23+
`Content-Type` header, which servers should be prepared to accept.
24+
2225
See the [Authentication doc](./authentication.md) for more info on how LFS
2326
gets authorizes Batch API requests.
2427

docs/api/locking.md

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ All File Locking requests require the following HTTP headers:
1818
Accept: application/vnd.git-lfs+json
1919
Content-Type: application/vnd.git-lfs+json
2020

21+
The client may also include a `charset=utf-8` parameter in the
22+
`Content-Type` header, which servers should be prepared to accept.
23+
2124
See the [Authentication doc](./authentication.md) for more info on how LFS
2225
gets authorizes Batch API requests.
2326

0 commit comments

Comments
 (0)