ethersphere / bee

Bee is a Swarm client implemented in Go. It’s the basic building block for the Swarm network: a private; decentralized; and self-sustaining network for permissionless publishing and access to your (application) data.
https://www.ethswarm.org
BSD 3-Clause "New" or "Revised" License
1.44k stars 338 forks source link

Consistently add return values for endpoints #4620

Open NoahMaizels opened 3 months ago

NoahMaizels commented 3 months ago

Location

Entire docs

Description

For multiple endpoints, potential return values are missing. Where there are a defined and limited set of possible return values, it would be very helpful to return those values as a list in the OpenAPI specs. For example, with the /node endpoint, there is a value "beeMode", for which I believe the only possible values are "full" and "light". However there is also the concept of a "ultra light" node, so it would be helpful to specify what the possible return values are. There are other similar examples throughout the API. Currently hunting through the Bee client code itself is the only way to find these values.