Common types
Error
Field | Type | Required | Notes |
---|
reason | BadRequest | NotFound | TooLarge | Unauthorized | Forbidden | Conflict | Internal | Unavailable | Yes | Machine-readable category |
message | string | Yes | Human-readable explanation |
The following table maps HTTP codes to their respective reason
:
HTTP code | Reason |
---|
400 Bad Request | BadRequest |
401 Unauthorized | Unauthorized |
403 Forbidden | Forbidden |
404 Not Found | NotFound |
409 Conflict | Conflict |
413 Entity Too Large | TooLarge |
500 Internal Server Error | Internal |
503 Service Unavailable | Unavailable |
Field | Type | Required | Notes |
---|
cursor | string | | Opaque cursor token for the next page |
ListOptions
Field | Type | Required | Notes |
---|
limit | int | | Soft page-size cap; server may return fewer |
cursor | string | | Cursor from a previous list response |
selector | string | | Selector expression (see filtering) |