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

spec: add missing explicit line breaks

Browse Source 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-05-29 10:14:54 +02:00
parent 823974551d
commit da72ccbf70
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
spec/README.md
+8 -8
View File
@@ -224,7 +224,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
* **Code**: `400 Invalid Route Spec` * **Code**: `400 Invalid Route Spec`
* **Code**: `400 Missing Mandatory Field`<br /> * **Code**: `400 Missing Mandatory Field`<br />
**Header**: `Content-Type: application/json`<br /> **Header**: `Content-Type: application/json`<br />
**Content**: **Content**:<br />
```json ```json
{ {
"missing_mandatory_fields": [ "missing_mandatory_fields": [
@@ -233,7 +233,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
] ]
} }
``` ```
* **Sample Call**: * **Sample Call**:<br />
```sh ```sh
$ curl -X POST --data-binary @- $KAPOW_URL/routes <<EOF $ curl -X POST --data-binary @- $KAPOW_URL/routes <<EOF
{ {
@@ -288,7 +288,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
* **Code**: `400 Invalid Route Spec` * **Code**: `400 Invalid Route Spec`
* **Code**: `400 Missing Mandatory Field`<br /> * **Code**: `400 Missing Mandatory Field`<br />
**Header**: `Content-Type: application/json`<br /> **Header**: `Content-Type: application/json`<br />
**Content**: **Content**:<br />
```json ```json
{ {
"missing_mandatory_fields": [ "missing_mandatory_fields": [
@@ -301,7 +301,7 @@ Accepts JSON data that defines a new route to be appended to the current routes.
* **Code**: `400 Index Already in Use` * **Code**: `400 Index Already in Use`
* **Code**: `404 Invalid Index` * **Code**: `404 Invalid Index`
* **Code**: `404 Invalid Route Spec` * **Code**: `404 Invalid Route Spec`
* **Sample Call**: * **Sample Call**:<br />
```sh ```sh
$ curl -X PUT --data-binary @- $KAPOW_URL/routes <<EOF` $ curl -X PUT --data-binary @- $KAPOW_URL/routes <<EOF`
{ {
@@ -331,7 +331,7 @@ Removes the route identified by `:id`.
* **Method**: `DELETE` * **Method**: `DELETE`
* **Success Responses**: * **Success Responses**:
* **Code**: `200 OK`<br /> * **Code**: `200 OK`<br />
**Content**: **Content**:<br />
```json ```json
{ {
"method": "GET", "method": "GET",
@@ -343,7 +343,7 @@ Removes the route identified by `:id`.
``` ```
* **Error Responses**: * **Error Responses**:
* **Code**: `404 Not Found` * **Code**: `404 Not Found`
* **Sample Call**: * **Sample Call**:<br />
```sh ```sh
$ curl -X DELETE $KAPOW_URL/routes/ROUTE_1f186c92_f906_4506_9788_a1f541b11d0f $ curl -X DELETE $KAPOW_URL/routes/ROUTE_1f186c92_f906_4506_9788_a1f541b11d0f
``` ```
@@ -489,7 +489,7 @@ Returns the value of the requested resource path, or an error if the resource pa
**Code**: `400 Invalid Resource Path`<br /> **Code**: `400 Invalid Resource Path`<br />
**Notes**: Check the list of valid resource paths at the top of this section. **Notes**: Check the list of valid resource paths at the top of this section.
* **Code**: `404 Not Found` * **Code**: `404 Not Found`
* **Sample Call**: * **Sample Call**:<br />
```sh ```sh
$ curl /handlers/$KAPOW_HANDLER_ID/request/body $ curl /handlers/$KAPOW_HANDLER_ID/request/body
``` ```
@@ -511,7 +511,7 @@ Returns the value of the requested resource path, or an error if the resource pa
* **Code**: `404 Handler Not Found` * **Code**: `404 Handler Not Found`
* **Code**: `404 Name Not Found`<br /> * **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. **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**: * **Sample Call**:<br />
```sh ```sh
FIXME: python snippet instead? FIXME: python snippet instead?
$ curl -X PUT /handlers/$KAPOW_HANDLER_ID/response/body < /tmp/some_file $ curl -X PUT /handlers/$KAPOW_HANDLER_ID/response/body < /tmp/some_file