Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Less errors, less complex.

Browse Source
This commit is contained in:
César Gallego Rodríguez
2019-08-21 10:15:55 +02:00
parent c834bd4447
commit 2eaac52a03
1 changed files with 2 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
spec/README.md
+2 -32
View File
@@ -243,19 +243,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
``` ```
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Malformed JSON` * **Code**: `400 Malformed JSON`
* **Code**: `422 Invalid Data Type`
* **Code**: `422 Invalid Route Spec` * **Code**: `422 Invalid Route Spec`
* **Code**: `422 Missing Mandatory Field`<br />
**Header**: `Content-Type: application/json`<br />
**Content**:<br />
```json
{
"missing_mandatory_fields": [
"url_pattern",
"command"
]
}
```
* **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
@@ -307,20 +295,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
``` ```
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Malformed JSON` * **Code**: `400 Malformed JSON`
* **Code**: `422 Invalid Data Type`
* **Code**: `422 Invalid Route Spec` * **Code**: `422 Invalid Route Spec`
* **Code**: `422 Missing Mandatory Field`<br />
**Header**: `Content-Type: application/json`<br />
**Content**:<br />
```json
{
"missing_mandatory_fields": [
"url_pattern",
"command"
]
}
```
* **Code**: `422 Invalid Index Type`
* **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`
@@ -526,17 +501,12 @@ Returns the value of the requested resource path, or an error if the resource pa
* **Success Responses**: * **Success Responses**:
* **Code**: `200 OK` * **Code**: `200 OK`
* **Error Responses**: * **Error Responses**:
* **Code**: `400 Invalid Payload` * **Code**: `400 Invalid Resource`
* **Code**: `400 Invalid Resource Path`<br /> * **Code**: `404 Not Found`
**Notes**: Check the list of valid resource paths at the top of this section.
* **Code**: `404 Handler Not Found`
* **Code**: `404 Name Not Found`<br />
**Notes**: Although the resource path is correct, no such name is present in the request. For instance, `/request/headers/Foo`, when no `Foo` header is not present in the request.
* **Sample Call**:<br /> * **Sample Call**:<br />
```sh ```sh
$ curl -X --data-binary '<h1>Hello!</h1>' PUT /handlers/$KAPOW_HANDLER_ID/response/body $ curl -X --data-binary '<h1>Hello!</h1>' PUT /handlers/$KAPOW_HANDLER_ID/response/body
``` ```
* **Notes**:
## Usage Example ## Usage Example