From b9aae2e1615783d0b9d3952878163e98df85ce04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Abdelkader=20Mart=C3=ADnez=20P=C3=A9rez?= Date: Mon, 20 May 2019 15:58:31 +0200 Subject: [PATCH] Added additional notes in the documentation. Co-authored-by: pancho horrillo --- spec/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/spec/README.md b/spec/README.md index 104cedd..7b53ca9 100644 --- a/spec/README.md +++ b/spec/README.md @@ -156,7 +156,7 @@ Returns JSON data about the current routes. * **Data Params** * **Content**: - ```json + ``` { "method": "GET", "url_pattern": "/hello", @@ -170,7 +170,7 @@ Returns JSON data about the current routes. * **Code**: `200 OK`
**Header**: `Content-Type: application/json`
**Content**: - ```json + ``` { "method": "GET", "url_pattern": "/hello", @@ -194,7 +194,9 @@ Returns JSON data about the current routes. TODO * **Notes** -TODEL if NIL + + * A successful request will yield a response containing all the effective + parameters that were applied. #### Insert a route @@ -214,7 +216,7 @@ TODEL if NIL * **Data Params** * **Content**: - ```json + ``` { "method": "GET", "url_pattern": "/hello", @@ -228,7 +230,7 @@ TODEL if NIL * **Code**: `200 OK`
**Header**: `Content-Type: application/json`
**Content**: - ```json + ``` { "method": "GET", "url_pattern": "/hello", @@ -258,6 +260,8 @@ TODO first, effectively making it index 0. * Conversely when `index` is greater than the number of entries on the route table it will be inserted last. + * A successful request will yield a response containing all the effective + parameters that were applied. #### Delete a route * **URL**