Skip to content

Add missing parameter descriptions in API spec #766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
crtahlin wants to merge 1 commit into from
Closed

Add missing parameter descriptions in API spec #766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions openapi/Swarm.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down