Skip to content

Update OpenAPI specs to Bee v2.8.2 #844

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

Open
bee-runner wants to merge 1 commit into
base: master
Choose a base branch
from
+138 −26
Open

Update OpenAPI specs to Bee v2.8.2 #844

Show file tree
Hide file tree
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: 2 additions & 2 deletions docs/bee/installation/build-from-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Prerequisites for installing directly from source are:
3. Checkout the required version:

```bash
git checkout v2.8.1
git checkout v2.8.2
```

4. Build the binary:
Expand All @@ -48,7 +48,7 @@ Prerequisites for installing directly from source are:
```

```
2.8.1
2.8.2
```

6. (optional) Additionally, you may also like to move the Bee binary to somewhere in your `$PATH`
Expand Down
14 changes: 7 additions & 7 deletions docs/bee/installation/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: Provides comprehensive steps for deploying Bee nodes using Docker c
The following is a guide for installing a Bee node using Docker. Docker images for Bee are hosted at [Docker Hub](https://hub.docker.com/r/ethersphere/bee). Using Docker to operate your Bee node offers many benefits, such as ease of deployment and consistency across environments.

:::caution
In the examples below we specify the exact image version as 2.8.1.
In the examples below we specify the exact image version as 2.8.2.
It's recommended to only use the exact version number tags.
Make sure to check that you're on the latest version of Bee by reviewing the tags for Bee on [Docker Hub](https://hub.docker.com/r/ethersphere/bee/tags), and replace 2.8.1 in the commands below if there is a newer full release.
Make sure to check that you're on the latest version of Bee by reviewing the tags for Bee on [Docker Hub](https://hub.docker.com/r/ethersphere/bee/tags), and replace 2.8.2 in the commands below if there is a newer full release.
:::

:::warning
Expand Down Expand Up @@ -39,13 +39,13 @@ docker run -d --name bee-1 \
-e BEE_PASSWORD="flummoxedgranitecarrot" \
-e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org" \
-v bee-1:/home/bee/.bee \
ethersphere/bee:2.8.1 start
ethersphere/bee:2.8.2 start
```

Here is the same command in a single line in case you run into issues with the line breaks in the command above:

```bash
docker run -d --name bee-1 --restart always -p 127.0.0.1:1633:1633 -p 1634:1634 -e BEE_API_ADDR=":1633" -e BEE_FULL_NODE="true" -e BEE_SWAP_ENABLE="true" -e BEE_PASSWORD="flummoxedgranitecarrot" -e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org" -v bee-1:/home/bee/.bee ethersphere/bee:2.8.1 start
docker run -d --name bee-1 --restart always -p 127.0.0.1:1633:1633 -p 1634:1634 -e BEE_API_ADDR=":1633" -e BEE_FULL_NODE="true" -e BEE_SWAP_ENABLE="true" -e BEE_PASSWORD="flummoxedgranitecarrot" -e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org" -v bee-1:/home/bee/.bee ethersphere/bee:2.8.2 start
```

#### Command explained:
Expand All @@ -61,7 +61,7 @@ docker run -d --name bee-1 --restart always -p 127.0.0.1:1633:1633 -p 1634:1634
- **`-e BEE_PASSWORD="flummoxedgranitecarrot"`**: Sets the keystore password, make sure to replace with your own.
- **`-e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org"`**: Connects to the Gnosis Chain.
- **`-v bee-1:/home/bee/.bee`**: Persists node data in the `bee-1` volume.
- **`ethersphere/bee:2.8.1 start`**: Runs Bee version 2.8.1 and starts the node.
- **`ethersphere/bee:2.8.2 start`**: Runs Bee version 2.8.2 and starts the node.

This setup runs the Bee node in a container, with full node functionality, SWAP enabled, and connections to the Gnosis blockchain for chequebook and postage stamp management, while persisting its data using a volume.

Expand All @@ -77,7 +77,7 @@ If everything is set up correctly, you should see your Bee node listed:

```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
37f4ad8b4060 ethersphere/bee:2.8.1 "bee start" 6 seconds ago Up 5 seconds 127.0.0.1:1633->1633/tcp, 0.0.0.0:1634->1634/tcp, :::1634->1634/tcp bee-1
37f4ad8b4060 ethersphere/bee:2.8.2 "bee start" 6 seconds ago Up 5 seconds 127.0.0.1:1633->1633/tcp, 0.0.0.0:1634->1634/tcp, :::1634->1634/tcp bee-1
```

And check the logs:
Expand Down Expand Up @@ -170,7 +170,7 @@ damage to hardware or loss of funds associated with the Ethereum account connect
No developers or entity involved will be liable for any claims and damages associated with your use,
inability to use, or your interaction with other nodes or the software.

"time"="2026-07-07 16:52:59.641444" "level"="info" "logger"="node" "msg"="bee version" "version"="2.8.1-7cf53193"
"time"="2026-07-07 16:52:59.641444" "level"="info" "logger"="node" "msg"="bee version" "version"="2.8.2-7cf53193"
"time"="2026-07-07 16:52:59.793257" "level"="info" "logger"="node" "msg"="swarm public key"
"public_key"="02d8d7e1ca6b3b43653ae27e35a375dd74e3ce2f40587fd264bc7268ed918650ab"
"time"="2026-07-07 16:53:00.087534" "level"="info" "logger"="node" "msg"="pss public key" "public_key"="02aaae4ede42f47f48aa5182df4b94039ca71254f44ebc5383d5a67f71fe7e6156"
Expand Down
12 changes: 6 additions & 6 deletions docs/bee/installation/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ Run the shell script using `curl` or `wget`:


:::tip
We specify `TAG=v2.8.1` to indicate which Bee version to install. You can find available versions in the ["releases" section](https://github.com/ethersphere/bee/releases) of the Bee GitHub repo.
We specify `TAG=v2.8.2` to indicate which Bee version to install. You can find available versions in the ["releases" section](https://github.com/ethersphere/bee/releases) of the Bee GitHub repo.
:::

```bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.1 bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.2 bash
```

OR

```bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.1 bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.2 bash
```

Verify installation:
Expand Down Expand Up @@ -109,7 +109,7 @@ damage to hardware or loss of funds associated with the Ethereum account connect
No developers or entity involved will be liable for any claims and damages associated with your use,
inability to use, or your interaction with other nodes or the software.

"time"="2026-07-07 16:52:59.641444" "level"="info" "logger"="node" "msg"="bee version" "version"="2.8.1-7cf53193"
"time"="2026-07-07 16:52:59.641444" "level"="info" "logger"="node" "msg"="bee version" "version"="2.8.2-7cf53193"
"time"="2026-07-07 16:52:59.793257" "level"="info" "logger"="node" "msg"="swarm public key"
"public_key"="02d8d7e1ca6b3b43653ae27e35a375dd74e3ce2f40587fd264bc7268ed918650ab"
"time"="2026-07-07 16:53:00.087534" "level"="info" "logger"="node" "msg"="pss public key" "public_key"="02aaae4ede42f47f48aa5182df4b94039ca71254f44ebc5383d5a67f71fe7e6156"
Expand Down Expand Up @@ -181,7 +181,7 @@ swarm-cli status
```bash
Bee
API: http://localhost:1633 [OK]
Version: 2.8.1-7cf53193
Version: 2.8.2-7cf53193
Mode: light

Chainsync
Expand Down Expand Up @@ -211,7 +211,7 @@ swarm-cli status
```bash
Bee
API: http://localhost:1633 [OK]
Version: 2.8.1-7cf53193
Version: 2.8.2-7cf53193
Mode: light

Chainsync
Expand Down
6 changes: 3 additions & 3 deletions docs/bee/installation/shell-script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Below is a step-by-step guide for installing and setting up your Bee node using
Run the install shell script using either `curl` or `wget`:

:::caution
In the example below, the version is specified using `TAG=v2.8.1`. Check the [latest Bee releases](https://github.com/ethersphere/bee/tags) and if needed, update the command to install the most recent version (note that in tags containing "rc," the abbreviation stands for "release candidate", and these versions should be used for testing purposes only).
In the example below, the version is specified using `TAG=v2.8.2`. Check the [latest Bee releases](https://github.com/ethersphere/bee/tags) and if needed, update the command to install the most recent version (note that in tags containing "rc," the abbreviation stands for "release candidate", and these versions should be used for testing purposes only).
:::

:::info
Expand Down Expand Up @@ -59,15 +59,15 @@ values={[
<TabItem value="curl">

```bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.1 bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.2 bash
```
</TabItem>
<TabItem value="wget">

**wget**

```bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.1 bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.2 bash
```
</TabItem>

Expand Down
2 changes: 1 addition & 1 deletion docs/bee/working-with-bee/bee-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ curl -s http://localhost:1633/health | jq
```json
{
"status": "ok",
"version": "2.8.1-7cf53193",
"version": "2.8.2-7cf53193",
"apiVersion": "8.1.0"
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/bee/working-with-bee/staking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,12 +481,12 @@ curl -s http://localhost:1633/health | jq

To confirm a successful update, check that the value for the `"version"` field in the results corresponds to the version number of the [latest](https://github.com/ethersphere/bee/releases/latest) Bee release.

For example, if the latest version was 2.8.1, it would look like this:
For example, if the latest version was 2.8.2, it would look like this:

```json
{
"status": "ok",
"version": "2.8.1-7cf53193",
"version": "2.8.2-7cf53193",
"apiVersion": "8.1.0"
}
```
Expand Down
122 changes: 117 additions & 5 deletions openapi/Swarm.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3

info:
version: 8.1.0
version: 8.1.1
title: Bee API
description: "API endpoints for interacting with the Swarm network, supporting file operations, messaging, and node management"

Expand Down Expand Up @@ -246,6 +246,9 @@ paths:
description: Default response
head:
summary: Retrieve headers containing the content type and length for the reference
description: >
Identical to GET on the same reference except that no content is sent,
so Range and conditional request headers are honored the same way.
tags:
- Bytes
parameters:
Expand All @@ -255,32 +258,77 @@ paths:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of chunk
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyStrategyParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyFallbackModeParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyLevelParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmChunkRetrievalTimeoutParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
responses:
"200":
description: The chunk exists.
description: Headers for the content at the reference.
headers:
Content-Type:
description: The MIME type of the resource (e.g., application/octet-stream).
schema:
type: string
example: application/octet-stream
Content-Length:
description: The size of the chunk in bytes.
description: The size of the retrievable content in bytes.
schema:
type: integer
example: 1024
Accept-Ranges:
description: Indicates that ranged requests are supported for the reference.
schema:
type: string
example: bytes
ETag:
description: The reference, as an entity tag.
schema:
type: string
Last-Modified:
description: The time the response was generated.
schema:
type: string
Access-Control-Expose-Headers:
description: Headers exposed for CORS.
schema:
type: string
example: Accept-Ranges, Content-Encoding
example: Content-Disposition
"206":
description: Headers for the range requested via the Range header.
headers:
Content-Range:
description: The range covered, and the total size of the content.
schema:
type: string
example: bytes 0-1023/4096
Content-Length:
description: The size of the requested range in bytes.
schema:
type: integer
example: 1024
"304":
description: The entity tag in If-None-Match matches the reference.
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"412":
description: A conditional request header was not satisfied.
"416":
description: The requested range cannot be satisfied.
headers:
Content-Range:
description: The total size of the content.
schema:
type: string
example: bytes */4096
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response

Expand Down Expand Up @@ -469,6 +517,9 @@ paths:
description: Default response
head:
summary: Retrieve headers with content type and length for the reference
description: >
Identical to GET on the same reference except that no content is sent,
so Range and conditional request headers are honored the same way.
tags:
- BZZ
parameters:
Expand All @@ -478,16 +529,77 @@ paths:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of chunk
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyStrategyParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyFallbackModeParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyLevelParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmChunkRetrievalTimeoutParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
responses:
"200":
description: Chunk exists
description: Headers for the content at the reference.
headers:
Content-Type:
description: The MIME type of the resource.
schema:
type: string
example: application/octet-stream
Content-Length:
description: The size of the retrievable content in bytes.
schema:
type: integer
example: 1024
Accept-Ranges:
description: Indicates that ranged requests are supported for the reference.
schema:
type: string
example: bytes
ETag:
description: The reference, as an entity tag.
schema:
type: string
Last-Modified:
description: The time the response was generated.
schema:
type: string
Access-Control-Expose-Headers:
description: Headers exposed for CORS.
schema:
type: string
example: Content-Disposition
"206":
description: Headers for the range requested via the Range header.
headers:
Content-Range:
description: The range covered, and the total size of the content.
schema:
type: string
example: bytes 0-1023/4096
Content-Length:
description: The size of the requested range in bytes.
schema:
type: integer
example: 1024
"304":
description: The entity tag in If-None-Match matches the reference.
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"412":
description: A conditional request header was not satisfied.
"416":
description: The requested range cannot be satisfied.
headers:
Content-Range:
description: The total size of the content.
schema:
type: string
example: bytes */4096
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response

Expand Down
Loading