mirror of
https://github.com/aljazceru/cyphernode.git
synced 2026-01-31 10:14:35 +01:00
Fixed some documentation
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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"
|
||||
|
||||
Reference in New Issue
Block a user