Removed references to reason phrase from spec. Closes #66

This commit is contained in:
Héctor Hurtado
2019-10-25 10:15:21 +02:00
parent c3be29255a
commit d9e072f89a
+16 -18
View File
@@ -131,13 +131,10 @@ whole lifetime of the server.
conservative in what you do, be liberal in what you accept from others. conservative in what you do, be liberal in what you accept from others.
* We reuse conventions of well-established software projects, such as Docker. * We reuse conventions of well-established software projects, such as Docker.
* All requests and responses will leverage JSON as the data encoding method. * All requests and responses will leverage JSON as the data encoding method.
* The API calls responses have several parts: * The API calls responses have two parts:
* The HTTP status code (e.g., `400`, which is a bad request). The target * The HTTP status code (e.g., `400`, which is a bad request). The target
audience of this information is the client code. The client can thus use audience of this information is the client code. The client can thus use
this information to control the program flow. this information to control the program flow.
* The HTTP reason phrase. The target audience in this case is the human
operating the client. The human can use this information to make a
decision on how to proceed.
* The body is optional * The body is optional
* All successful API calls will return a representation of the *final* state * All successful API calls will return a representation of the *final* state
attained by the objects which have been addressed (either requested, set or attained by the objects which have been addressed (either requested, set or
@@ -245,8 +242,8 @@ A new id is created for the appended route so it can be referenced later.
} }
``` ```
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Malformed JSON` * **Code**: `400 Bad Request`
* **Code**: `422 Invalid Route` * **Code**: `422 Unprocessable Entity`
* **Sample Call**:<br /> * **Sample Call**:<br />
```sh ```sh
$ curl -X POST --data-binary @- $KAPOW_URL/routes <<EOF $ curl -X POST --data-binary @- $KAPOW_URL/routes <<EOF
@@ -298,8 +295,8 @@ A new id is created for the appended route so it can be referenced later.
} }
``` ```
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Malformed JSON` * **Code**: `400 Bad Request`
* **Code**: `422 Invalid Route` * **Code**: `422 Unprocessable Entity`
* **Sample Call**:<br /> * **Sample Call**:<br />
```sh ```sh
$ curl -X PUT --data-binary @- $KAPOW_URL/routes <<EOF` $ curl -X PUT --data-binary @- $KAPOW_URL/routes <<EOF`
@@ -384,9 +381,8 @@ response.
* The HTTP status code (e.g., `400`, which is a bad request). The target * The HTTP status code (e.g., `400`, which is a bad request). The target
audience of this information is the client code. The client can thus use audience of this information is the client code. The client can thus use
this information to control the program flow. this information to control the program flow.
* The HTTP reason phrase. The target audience in this case is the human * The HTTP body. On read requests, containing the data retrieved as
operating the client. The human can use this information to make a 'application/octet-stream' mime type.
decision on how to proceed.
* Regarding HTTP request and response bodies: * Regarding HTTP request and response bodies:
* The response body will be empty in case of error. * The response body will be empty in case of error.
* It will transport binary data in other case. * It will transport binary data in other case.
@@ -513,11 +509,12 @@ path doesn't exist or is invalid.
**Header**: `Content-Type: application/octet-stream`<br /> **Header**: `Content-Type: application/octet-stream`<br />
**Content**: The value of the resource. Note that it may be empty. **Content**: The value of the resource. Note that it may be empty.
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Invalid Resource Path`<br /> * **Code**: `400 Bad Request`<br />
**Notes**: Check the list of valid resource paths at the top of this section. **Notes**: An invalid resource path has been requested. Check the list of
* **Code**: `404 Handler ID Not Found`<br /> valid resource paths at the top of this section.
* **Code**: `404 Not Found`<br />
**Notes**: Refers to the handler resource itself. **Notes**: Refers to the handler resource itself.
* **Code**: `404 Resource Item Not Found`<br /> * **Code**: `404 Not Found`<br />
**Notes**: Refers to the named item in the corresponding data API resource. **Notes**: Refers to the named item in the corresponding data API resource.
* **Sample Call**:<br /> * **Sample Call**:<br />
```sh ```sh
@@ -536,9 +533,10 @@ path doesn't exist or is invalid.
* **Success Responses**: * **Success Responses**:
* **Code**: `200 OK` * **Code**: `200 OK`
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Invalid Resource Path`<br /> * **Code**: `400 Bad Request`<br />
**Notes**: Check the list of valid resource paths at the top of this section. **Notes**: An invalid resource path has been requested. Check the list of
* **Code**: `404 Handler ID Not Found`<br /> valid resource paths at the top of this section.
* **Code**: `404 Not Found`<br />
**Notes**: Refers to the handler resource itself. **Notes**: Refers to the handler resource itself.
* **Sample Call**:<br /> * **Sample Call**:<br />
```sh ```sh