docs/api: object size must be positive

This commit is contained in:
Taylor Blau 2016-12-15 22:46:18 -07:00
parent 96dba41203
commit 290437050c
2 changed files with 4 additions and 3 deletions

@ -31,7 +31,7 @@ that the client has configured. If omitted, the `basic` transfer adapter MUST
be assumed by the server.
* `objects` - An Array of objects to download.
* `oid` - String OID of the LFS object.
* `size` - Integer byte size of the LFS object.
* `size` - Integer byte size of the LFS object. Must be at least zero.
Note: Git LFS currently only supports the `basic` transfer adapter. This
property was added for future compatibility with some experimental transfer
@ -70,7 +70,7 @@ client will use the `basic` transfer adapter if the `transfer` property is
omitted.
* `objects` - An Array of objects to download.
* `oid` - String OID of the LFS object.
* `size` - Integer byte size of the LFS object.
* `size` - Integer byte size of the LFS object. Must be at least zero.
* `authenticated` - Optional boolean specifying whether the request for this
specific object is authenticated. If omitted or false, Git LFS will attempt
to [find credentials for this URL](./authentication.md).

@ -21,7 +21,8 @@
"type": "string"
},
"size": {
"type": "number"
"type": "number",
"minimum": 0
},
"authenticated": {
"type": "boolean"