lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/api: document a new batch error code

Browse Source 
In some cases, it may be useful to return an error code if the number of
objects in the batch response is too larger for the server to handle.
Document the 413 error code for this case, since it is in use by at
least one implementation for this purpose.
This commit is contained in:
brian m. carlson 2019-05-10 14:38:32 +00:00
parent 8af45c113d
commit 883cacf9cb
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/batch.md
View File

@ -262,6 +262,8 @@ The following status codes can optionally be returned from the API, depending on
the server implementation. the server implementation.
* 406 - The Accept header needs to be `application/vnd.git-lfs+json`. * 406 - The Accept header needs to be `application/vnd.git-lfs+json`.
* 413 - The batch API request contained too many objects or the request was
otherwise too large.
* 429 - The user has hit a rate limit with the server. Though the API does not * 429 - The user has hit a rate limit with the server. Though the API does not
specify any rate limits, implementors are encouraged to set some for specify any rate limits, implementors are encouraged to set some for
availability reasons. availability reasons.