From 3661e0020c320cdda3bdfc6c9319489c9d83e7a3 Mon Sep 17 00:00:00 2001
From: Crt Ahlin <crt.ahlin@gmail.com>
Date: Tue, 27 Jan 2026 10:47:28 +0100
Subject: [PATCH] Add missing parameter descriptions in API spec

- Add description for immutable header in POST /stamps/{amount}/{depth}
- Add description for amount query param in POST /wallet/withdraw/{coin}
- Add description for address query param in POST /wallet/withdraw/{coin}
- Add description for coin path param in POST /wallet/withdraw/{coin}

Closes #2
---
 openapi/Swarm.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/openapi/Swarm.yaml b/openapi/Swarm.yaml
index 04c17b0ee..b70bd62ba 100644
--- a/openapi/Swarm.yaml
+++ b/openapi/Swarm.yaml
@@ -1988,6 +1988,7 @@ paths:
           schema:
             type: boolean
           required: false
+          description: Whether the postage batch is immutable. Immutable batches permanently store data and do not allow overwriting older chunks with new ones. Mutable batches allow overwriting older data as new chunks are added. Default batch type is immutable.
         - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
         - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
       responses:
@@ -2200,16 +2201,19 @@ paths:
           required: true
           schema:
             $ref: "SwarmCommon.yaml#/components/schemas/BigInt"
+          description: Amount of tokens to withdraw in the lowest denomination (PLUR for xBZZ, wei for xDAI)
         - in: query
           name: address
           required: true
           schema:
             $ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
+          description: Destination Ethereum address for the withdrawal. Must be whitelisted using the withdrawal-addresses-whitelist configuration option.
         - in: path
           name: coin
           required: true
           schema:
             $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
+          description: "Token type to withdraw. Use BZZ for xBZZ or NativeToken for xDAI."
       responses:
         "200":
           content: