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

/readiness endpoint clarification #4619

Open NoahMaizels opened 3 months ago

NoahMaizels commented 3 months ago

Location

https://docs.ethswarm.org/api/#tag/Status/paths/~1readiness/get

Description

Currently in the OpenAPI specs for the /readiness endpoint a return object is shown.

{ "code": 0, "message": "string", "reasons": [ "string" ] }

Actually there is no return object. The return object should be removed and an explanation should be added to the openapi specs to explain that this endpoint is used by infra tools like Docker / k8s to check if the API is set up and responsive and only returns an OK header