From bc00ec32fdc3df2fd520411bdcaf43ddc45147e6 Mon Sep 17 00:00:00 2001 From: kexkey Date: Tue, 3 Dec 2019 09:58:42 -0500 Subject: [PATCH] Fixed some documentation --- doc/API.v0.md | 2 +- doc/openapi/v0/cyphernode-api.yaml | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/API.v0.md b/doc/API.v0.md index 93b371d..ff8633a 100644 --- a/doc/API.v0.md +++ b/doc/API.v0.md @@ -4,7 +4,7 @@ ### Watch a Bitcoin Address (called by application) -Inserts the address and callbacks in the DB and imports the address to the Watching wallet. +Inserts the address and callbacks in the DB and imports the address to the Watching wallet. The callback URLs and event message are optional. If eventMessage is not supplied, tx_confirmation for that watch will not be published. Event message should be in base64 format to avoid dealing with escaping special characters. ```http POST http://cyphernode:8888/watch diff --git a/doc/openapi/v0/cyphernode-api.yaml b/doc/openapi/v0/cyphernode-api.yaml index 5d8b5a9..91b9c52 100644 --- a/doc/openapi/v0/cyphernode-api.yaml +++ b/doc/openapi/v0/cyphernode-api.yaml @@ -50,9 +50,6 @@ paths: type: "object" required: - "address" - - "confirmedCallbackURL" - - "unconfirmedCallbackURL" - - "event_message" properties: address: $ref: '#/components/schemas/TypeAddressString' @@ -62,7 +59,8 @@ paths: confirmedCallbackURL: type: "string" format: "url" - event_message: + eventMessage: + description: "Will be part of the published message on confirmations" type: "string" responses: '200': @@ -1546,7 +1544,7 @@ components: - "address" - "unconfirmedCallbackURL" - "confirmedCallbackURL" - - "event_message" + - "eventMessage" properties: id: type: "string" @@ -1578,7 +1576,7 @@ components: type: "string" watching_since: type: "string" - event_message: + eventMessage: type: "string" WatchedByXpubAddress: type: "object"