From d42ba92593a99541e001bbe129ae3c587cf711a8 Mon Sep 17 00:00:00 2001
From: kexkey <github@kexkey.com>
Date: Thu, 18 Nov 2021 11:23:05 -0500
Subject: [PATCH] Added openapi response schema for validateaddress

---
 doc/API.v0.md                      | 10 +++++++++-
 doc/openapi/v0/cyphernode-api.yaml | 24 ++++++++++++++++++++----
 2 files changed, 29 insertions(+), 5 deletions(-)

diff --git a/doc/API.v0.md b/doc/API.v0.md
index 32f822c..7abf53d 100644
--- a/doc/API.v0.md
+++ b/doc/API.v0.md
@@ -761,7 +761,7 @@ GET http://cyphernode:8888/validateaddress/address
 GET http://cyphernode:8888/validateaddress/tb1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqp3mvzv
 ```
 
-Proxy response:
+Proxy response for a valid address:
 
 ```json
 {
@@ -774,6 +774,14 @@ Proxy response:
 }
 ```
 
+Proxy response for an invalid address:
+
+```json
+{
+  "isvalid": false
+}
+```
+
 ### Spend coins from spending wallet (called by your application)
 
 Calls sendtoaddress RPC on the spending wallet with supplied info.  Can supply an eventMessage to be published on successful spending.  eventMessage should be base64 encoded to avoid dealing with escaping special characters.
diff --git a/doc/openapi/v0/cyphernode-api.yaml b/doc/openapi/v0/cyphernode-api.yaml
index d3c8aa7..b794adb 100644
--- a/doc/openapi/v0/cyphernode-api.yaml
+++ b/doc/openapi/v0/cyphernode-api.yaml
@@ -1201,12 +1201,28 @@ paths:
       operationId: "validateAddress"
       responses:
         '200':
-          description: "successful operation"
+          description: "operation successful"
           content:
             application/json:
               schema:
-                # TODO: describe response
                 type: "object"
+                required:
+                  - "isvalid"
+                properties:
+                  isvalid:
+                    type: "boolean"
+                  address:
+                    $ref: '#/components/schemas/TypeAddressString'
+                  scriptPubKey:
+                    type: "string"
+                  isscript:
+                    type: "boolean"
+                  iswitness:
+                    type: "boolean"
+                  witness_version:
+                    type: "number"
+                  witness_program:
+                    type: "string"
         '403':
           $ref: '#/components/schemas/ApiResponseNotAllowed'
         '503':
@@ -3084,9 +3100,9 @@ components:
       type: "string"
       pattern: "^[a-fA-F0-9]+$"
     TypeAddressString:
-      description: "base58 check encoded address"
+      description: "base58 or base32 check encoded address"
       type: "string"
-      pattern: "^[a-km-zA-HJ-NP-Z1-9]{26,35}$"
+      pattern: "^(bc1|tb1|bcrt1)[ac-hj-np-z02-9]{9,71}|[123mn][a-km-zA-HJ-NP-Z1-9]{26,33}$"
     TypeXpubString:
       description: "base58 check encoded xpub"
       type: "string"