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

describe the error object

Browse Source
This commit is contained in:
Rick Olson 2015-03-19 10:58:23 -06:00
parent 3f0d1d39a9
commit c269041a09
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/api.md
View File

@ -19,6 +19,8 @@ trigger specific error messages from the client.
* 200 - The request completed successfully.
* 202 - An upload request has been accepted. Clients should follow hypermedia
links to actually upload the content.
* 400 - General error with the client's request. Invalid JSON formatting, for
example.
* 401 - The authentication credentials are incorrect.
* 403 - The requesting user has access to see the repository, but not to push
changes to it.
@ -26,10 +28,8 @@ changes to it.
repository or requested object does not exist.
The following status codes can optionally be returned from the API, depending on
the implementation.
the server implementation.
* 400 - General error with the client's request. Invalid JSON formatting, for
example.
* 406 - The Accept header is invalid. It should be `application/vnd.hawser+json`.
* 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
@ -43,6 +43,24 @@ track usage.
Some server errors may trigger the client to retry requests, such as 500, 502,
503, and 504.
If the server returns a JSON error object, the client can display this message
to users.
```
> GET https://hawser-server.com/objects/{OID} HTTP/1.1
> Accept: application/vnd.hawser+json
>
< HTTP/1.1 200 OK
< Content-Type: application/vnd.hawser+json
<
< {
< "message": "Bad credentials",
< "documentation_url": "https://hawser-server.com/docs/errors"
< }
```
The `documentation_url` property is optional.
## Hypermedia
The Hawser API uses hypermedia hints to instruct the client what to do next.