Skip to content

Commit

Permalink
docs: fix API doc enums (#4754)
Browse files Browse the repository at this point in the history
  • Loading branch information
acha-bill authored Aug 26, 2024
1 parent cd86a9f commit a0d2879
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions openapi/SwarmCommon.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -465,12 +465,14 @@ components:
properties:
beeMode:
type: string
enum: [light, full, dev]
enum: [light, full, dev, ultra-light, unknown]
description: >
Gives back in what mode the Bee client has been started. The modes are mutually exclusive
* `light` - light node; does not participate in forwarding or storing chunks
* `full` - full node
* `dev` - development mode; Bee client for development purposes, blockchain operations are mocked
* `ultra-light` - ultra-light node; a light node with chain disabled
* `unknown` - unknown mode
chequebookEnabled:
type: boolean
swapEnabled:
Expand All @@ -481,11 +483,12 @@ components:
properties:
status:
type: string
enum: [ok, nok]
enum: [ok, nok, unknown]
description: >
Indicates health state of node
* `ok` - node is healthy
* `nok` - node is not healthy
* `unknown` - health status is unknown
version:
type: string
apiVersion:
Expand Down Expand Up @@ -888,6 +891,7 @@ components:
enum:
- "light"
- "full"
- "dev"
- "ultra-light"
- "unknown"
proximity:
Expand Down

0 comments on commit a0d2879

Please sign in to comment.