feat: openapi specs

ethersphere · Mar 12, 2024 · 0d3dccf · 0d3dccf
1 parent e70abdd
commit 0d3dccf
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/openapi/SwarmCommon.yaml b/openapi/SwarmCommon.yaml
@@ -969,6 +969,12 @@ components:
       schema:
         type: string
 
+    WalletTxResponse:
+      properties:
+        transactionHash:
+          $ref: "#/components/schemas/TransactionHash"
+      type: object
+
   parameters:
 
     GasPriceParameter:

diff --git a/openapi/SwarmDebug.yaml b/openapi/SwarmDebug.yaml
@@ -689,6 +689,42 @@ paths:
           $ref: "SwarmCommon.yaml#/components/responses/500"
         default:
           description: Default response
+
+  "/wallet/withdraw/{coin}":
+    get:
+      summary: Allows withdrawals of BZZ or xDAI to provided (whitelisted) address
+      tags:
+        - Wallet
+      parameters:
+      - in: query
+        name: amount
+        required: true
+        schema:
+          $ref: "#/components/schemas/BigInt"
+      - in: query
+        name: address
+        required: true
+        schema:
+          $ref: "#/components/schemas/EthereumAddress"
+      - in: path
+        name: coin
+        required: true
+        schema:
+          $ref: "#/components/schemas/SwarmAddress"
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WalletTxResponse'
+          description: OK
+        "400":
+          $ref: "SwarmCommon.yaml#/components/responses/400"
+          description: Amount greater than ballance or coin is other than BZZ/xDAI
+        "500":
+          $ref: "SwarmCommon.yaml#/components/responses/500"
+        default:
+          description: Default response
 
   "/transactions":
     get: