From 6671fa5f957f265092a0bfa2a96e88d02deabcb9 Mon Sep 17 00:00:00 2001 From: SKP Date: Thu, 14 Feb 2019 16:11:26 +0100 Subject: [PATCH] Started draft of v1 restful cyphernode API --- doc/API.v1.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/API.v1.md b/doc/API.v1.md index e941f6b..65c56c5 100644 --- a/doc/API.v1.md +++ b/doc/API.v1.md @@ -16,7 +16,7 @@ ##### POST /v1/watchedAddresses **Request body** -```json +``` { "address": , "callback": @@ -24,7 +24,7 @@ ``` **Response body - 200 - OK** -```json +``` { "id": , "address": , @@ -37,14 +37,14 @@ ``` **Response body - 503 - Resource temporarily unavailable** -```json +``` { "reason": } ``` **Response body - 403 - Forbidden** -```json +``` { } ``` @@ -52,7 +52,7 @@ ##### GET /v1/watchedAddresses **Response body - 200 - OK** -```json +``` [ { "id": , @@ -66,14 +66,14 @@ ``` **Response body - 503 - Resource temporarily unavailable** -```json +``` { "reason": } ``` **Response body - 403 - Forbidden** -```json +``` { } ``` @@ -81,7 +81,7 @@ ##### GET /v1/watchedAddresses/
**Response body - 200 - OK** -```json +``` { "id": , "address": , @@ -92,20 +92,20 @@ ``` **Response body - 503 - Resource temporarily unavailable** -```json +``` { "reason": } ``` **Response body - 403 - Forbidden** -```json +``` { } ``` **Response body - 404 - Not found** -```json +``` { } ``` @@ -114,7 +114,7 @@ ##### DELETE /v1/watchedAddresses/
**Response body - 200 - OK** -```json +``` { "address": "
", "imported": , @@ -124,20 +124,20 @@ ``` **Response body - 503 - Resource temporarily unavailable** -```json +``` { "reason": } ``` **Response body - 403 - Forbidden** -```json +``` { } ``` **Response body - 404 - Not found** -```json +``` { } ``` @@ -145,7 +145,7 @@ ##### Asynchronous callbacks **Request body** -```json +``` { "id": , "address": , @@ -165,13 +165,13 @@ ``` **Response body - 200 - OK** -```json +``` { } ``` **Response body - 503 - Resource temporarily unavailable** -```json +``` { "reason": }