From b3833ac606ccf3085e471221e55df215bd366076 Mon Sep 17 00:00:00 2001 From: significance Date: Fri, 26 Feb 2021 16:08:44 +0000 Subject: [PATCH] V0.5.3 dev (#147) * update api * bump version number * remove announcement for now * bump api specs * fix links * bump clef version * amend configuration --- docs/api-reference/api-reference.md | 4 +- docs/installation/bee-clef.md | 24 +++---- docs/installation/build-from-source.md | 4 +- docs/installation/configuration.md | 8 +-- docs/installation/docker.md | 6 +- docs/installation/manual.md | 6 +- docs/installation/quick-start.md | 24 +++---- docusaurus.config.js | 14 ++-- static/api/index.html | 92 ++++++++++++++------------ static/debug-api/index.html | 4 +- 10 files changed, 98 insertions(+), 88 deletions(-) diff --git a/docs/api-reference/api-reference.md b/docs/api-reference/api-reference.md index f52ed2c76..68c78815e 100644 --- a/docs/api-reference/api-reference.md +++ b/docs/api-reference/api-reference.md @@ -14,7 +14,7 @@ The API-endpoint exposes all functionality to upload and download content to and Detailed information about Bee API endpoint can be found here: -- Bee API reference. +- Bee API reference. ## Debug API @@ -24,7 +24,7 @@ The debug-API is disabled by default but be enabled by setting the `enable-debug For a new installation of Bee, the debug API endpoint is not yet exposed for security reasons. To enable the debug API endpoints, set `debug-api-enable` to `true` in your [configuration file](/docs/installation/configuration#configuring-bee-installed-using-a-package-manager) and restart your Bee service. ::: -- Debug API reference., +- Debug API reference., :::danger Your Debug API should not be exposed to the public internet, make sure that your network has a firewall which blocks port `1635`, or bind the Debug API to `localhost` diff --git a/docs/installation/bee-clef.md b/docs/installation/bee-clef.md index bbd5f8921..449270ebe 100644 --- a/docs/installation/bee-clef.md +++ b/docs/installation/bee-clef.md @@ -20,8 +20,8 @@ Bee clef can be installed automatically using your system's package manager. #### AMD64 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_amd64.deb -sudo dpkg -i bee-clef_0.4.7_amd64.deb +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_amd64.deb +sudo dpkg -i bee-clef_0.4.9_amd64.deb ``` #### ARM (Raspberry Pi) @@ -29,15 +29,15 @@ sudo dpkg -i bee-clef_0.4.7_amd64.deb ##### ARMv7 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_armv7.deb -sudo dpkg -i bee-clef_0.4.7_armv7.deb +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_armv7.deb +sudo dpkg -i bee-clef_0.4.9_armv7.deb ``` ##### ARM64 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_arm64.deb -sudo dpkg -i bee-clef_0.4.7_arm64.deb +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_arm64.deb +sudo dpkg -i bee-clef_0.4.9_arm64.deb ``` ### CentOS @@ -45,8 +45,8 @@ sudo dpkg -i bee-clef_0.4.7_arm64.deb #### AMD64 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_amd64.rpm -sudo rpm -i bee-clef_0.4.7_amd64.rpm +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_amd64.rpm +sudo rpm -i bee-clef_0.4.9_amd64.rpm ``` #### ARM (Raspberry Pi) @@ -54,15 +54,15 @@ sudo rpm -i bee-clef_0.4.7_amd64.rpm ##### ARMv7 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_armv7.rpm -sudo rpm -i bee-clef_0.4.7_armv7.rpm +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_armv7.rpm +sudo rpm -i bee-clef_0.4.9_armv7.rpm ``` ##### ARM64 ```sh -wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_arm64.rpm -sudo rpm -i bee-clef_0.4.7_arm64.rpm +wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.9/bee-clef_0.4.9_arm64.rpm +sudo rpm -i bee-clef_0.4.9_arm64.rpm ``` ### MacOS diff --git a/docs/installation/build-from-source.md b/docs/installation/build-from-source.md index 3fa2371fa..196d01497 100644 --- a/docs/installation/build-from-source.md +++ b/docs/installation/build-from-source.md @@ -31,7 +31,7 @@ git describe --tags 3) Checkout the required version: ```sh -git checkout v0.5.0 +git checkout v0.5.1 ``` 4) Build the binary: @@ -47,7 +47,7 @@ dist/bee version ``` ``` -0.5.0 +0.5.1 ``` 6) (optional) Additionally, you may also like to move the Bee binary to somewhere in your `$PATH` diff --git a/docs/installation/configuration.md b/docs/installation/configuration.md index 777892d06..42cd8d854 100644 --- a/docs/installation/configuration.md +++ b/docs/installation/configuration.md @@ -86,15 +86,15 @@ p2p-quic-enable: false p2p-ws-enable: false password: "" password-file: "" -payment-early: "10000" -payment-threshold: "100000" -payment-tolerance: "10000" +payment-early: "1000000000000" +payment-threshold: "10000000000000" +payment-tolerance: "50000000000000" resolver-options: [] standalone: false swap-enable: true swap-endpoint: http://localhost:8545 swap-factory-address: "" -swap-initial-deposit: "100000000" +swap-initial-deposit: "100000000000000000" tracing-enable: false tracing-endpoint: 127.0.0.1:6831 tracing-service-name: bee diff --git a/docs/installation/docker.md b/docs/installation/docker.md index 2d4241772..f4427fe83 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -71,7 +71,7 @@ docker pull ethersphere/bee:beta #### Specific Versions ```sh -docker pull ethersphere/bee:0.5.0 +docker pull ethersphere/bee:0.5.1 ``` #### Edge @@ -91,13 +91,13 @@ Configuration files for Bee and Bee Clef are provided to enable quick and easy i First, retrieve the current `docker-compose.yaml` file. ```sh -wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.0/packaging/docker/docker-compose.yml +wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.1/packaging/docker/docker-compose.yml ``` Next, create a `.env` file using the example file provided. This file will be responsible for storing configuration and secrets for our Bee and Bee Clef applications. ```sh -wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.0/packaging/docker/env -O .env +wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.1/packaging/docker/env -O .env ``` There are some important configuration parameters which must be set in order for our projects to work. To affect configuration in the `.env` file, we first remove the `#` at the beginning of the line and then change the value after `=` to our desired config. diff --git a/docs/installation/manual.md b/docs/installation/manual.md index 17c6f5a49..1af54e66b 100644 --- a/docs/installation/manual.md +++ b/docs/installation/manual.md @@ -13,12 +13,12 @@ To install the binary using our quick install script, run either one of the foll #### wget ```sh -wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.0 bash +wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.1 bash ``` #### curl ```sh -curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.0 bash +curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.1 bash ``` ### Bee Clef External Signer @@ -34,7 +34,7 @@ bee version ``` ``` -0.5.0 +0.5.1 ``` Now your Bee node is installed, you can fund your node with gBZZ join us in the swarm! 🐝 🐝 🐝 🐝 🐝 diff --git a/docs/installation/quick-start.md b/docs/installation/quick-start.md index 59eb15ec0..b2d5d027d 100644 --- a/docs/installation/quick-start.md +++ b/docs/installation/quick-start.md @@ -33,8 +33,8 @@ Follow post install guide in terminal for initial configuration and how to start #### AMD64 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_amd64.deb -sudo dpkg -i bee_0.5.0_amd64.deb +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_amd64.deb +sudo dpkg -i bee_0.5.1_amd64.deb ``` #### ARM (Raspberry Pi) @@ -42,15 +42,15 @@ sudo dpkg -i bee_0.5.0_amd64.deb ##### ARMv7 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_armv7.deb -sudo dpkg -i bee_0.5.0_armv7.deb +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_armv7.deb +sudo dpkg -i bee_0.5.1_armv7.deb ``` ##### ARM64 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_arm64.deb -sudo dpkg -i bee_0.5.0_arm64.deb +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_arm64.deb +sudo dpkg -i bee_0.5.1_arm64.deb ``` ### CentOS @@ -58,8 +58,8 @@ sudo dpkg -i bee_0.5.0_arm64.deb #### AMD64 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_amd64.rpm -sudo rpm -i bee_0.5.0_amd64.rpm +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_amd64.rpm +sudo rpm -i bee_0.5.1_amd64.rpm ``` #### ARM (Raspberry Pi) @@ -67,15 +67,15 @@ sudo rpm -i bee_0.5.0_amd64.rpm ##### ARMv7 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_armv7.rpm -sudo rpm -i bee_0.5.0_armv7.rpm +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_armv7.rpm +sudo rpm -i bee_0.5.1_armv7.rpm ``` ##### ARM64 ```sh -wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_arm64.rpm -sudo rpm -i bee_0.5.0_arm64.rpm +wget https://github.com/ethersphere/bee/releases/download/v0.5.1/bee_0.5.1_arm64.rpm +sudo rpm -i bee_0.5.1_arm64.rpm ``` ### MacOS diff --git a/docusaurus.config.js b/docusaurus.config.js index 0e397ae7a..7b2c8928c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -105,13 +105,13 @@ module.exports = { ], copyright: `Copyleft © ${new Date().getFullYear()}.`, }, - announcementBar: { - id: 'bee_announcements', - content: - '🐝 v0.5.0 is released feat. Swarm Feeds! Update your Bees now! 🐝', - backgroundColor: '#dd7200', // Defaults to `#fff`. - textColor: '#242424', // Defaults to `#000`. - }, + // announcementBar: { + // id: 'bee_announcements', + // content: + // '🐝 v0.5.0 is released feat. Swarm Feeds! Update your Bees now! 🐝', + // backgroundColor: '#dd7200', // Defaults to `#fff`. + // textColor: '#242424', // Defaults to `#000`. + // }, }, presets: [ [ diff --git a/static/api/index.html b/static/api/index.html index 75086bdc5..0b6031345 100644 --- a/static/api/index.html +++ b/static/api/index.html @@ -406,6 +406,9 @@ .gwbzWN{vertical-align:middle;font-size:13px;line-height:20px;border-radius:2px;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/ .gwbzWN + .sc-fznXWL{margin-left:0;}/*!sc*/ data-styled.g66[id="sc-fznXWL"]{content:"gwbzWN,"}/*!sc*/ +.cWhgfJ{vertical-align:middle;font-size:13px;line-height:20px;border-radius:2px;background-color:rgba(142,142,220,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);font-family:Courier,monospace;}/*!sc*/ +.cWhgfJ + .sc-fzqzlV{margin-left:0;}/*!sc*/ +data-styled.g68[id="sc-fzqzlV"]{content:"cWhgfJ,"}/*!sc*/ .hlGTig{margin:1em 0;}/*!sc*/ .hlGTig a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/ .hlGTig a:visited{color:#32329f;}/*!sc*/ @@ -567,35 +570,35 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

Swarm API (0.5.0)

Download OpenAPI specification:Download

A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages

+ " fill="currentColor">

Swarm API (0.5.1)

Download OpenAPI specification:Download

A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages

Browse the documentation @ the Swarm Docs

Bytes

Upload data

Authorizations:
header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

-
swarm-pin
boolean

Represents the pinning state of the bytes

-
swarm-encrypt
boolean

Represents the encrypting state of the bytes

+
swarm-pin
boolean

Represents the pinning state of the chunk

+
swarm-encrypt
boolean

Represents the encrypting state of the file

Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced data

Authorizations:
path Parameters
required
string or string or string

Swarm address reference to content

Responses

Response samples

Content type
application/problem+json
"string"

Chunk

Get Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

+

Response samples

Content type
application/problem+json
"string"

Chunk

Get Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

+
query Parameters
targets
string

Global pinning targets prefix

Responses

Response samples

Content type
application/problem+json
"string"

Upload Chunk

Authorizations:
header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

+

Response samples

Content type
application/problem+json
"string"

Upload Chunk

Authorizations:
header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

swarm-pin
boolean

Represents the pinning state of the chunk

Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

File

Upload file

Authorizations:
query Parameters
name
string

Filename

+

Response samples

Content type
application/json
{
  • "status": "string"
}

File

Upload file

Authorizations:
query Parameters
name
string

Filename

header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

-
swarm-pin
boolean

Represents the pinning state of the file

+
swarm-pin
boolean

Represents the pinning state of the chunk

swarm-encrypt
boolean

Represents the encrypting state of the file

Content-Type
string

The specified content-type is preserved for download of the asset

Request Body schema:
multipart/form-data
multipart/form-data
application/octet-stream
file
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+
query Parameters
targets
string

Global pinning targets prefix

Responses

Response samples

Content type
application/problem+json
"string"

Collection

Upload a collection

Authorizations:
header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

-
swarm-pin
boolean

Represents the pinning state of the collection

-
swarm-encrypt
boolean

Represents the encrypting state of the collection

+

Response samples

Content type
application/problem+json
"string"

Collection

Upload a collection

Authorizations:
header Parameters
swarm-tag
integer

Associate upload with an existing Tag UID

+
swarm-pin
boolean

Represents the pinning state of the chunk

+
swarm-encrypt
boolean

Represents the encrypting state of the file

swarm-index-document
string
Example: index.html

Default file to be referenced on path, if exists under that path

-
swarm-error-document
string
Example: error.html

Configure custom error document to be returned when a specified path can not be found in collection

+
swarm-error-document
string
Example: error.html

Configure custom error document to be returned when a specified path can not be found in collection

+
Content-Type
string

The specified content-type is preserved for download of the asset

Request Body schema: application/x-tar
string <binary>

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get index document from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get index document from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

query Parameters
targets
string

Global pinning targets prefix

Responses

Response samples

Content type
application/problem+json
"string"

Get referenced file from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+

Response samples

Content type
application/problem+json
"string"

Get referenced file from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

path
required
string

Path to the file in the collection.

query Parameters
targets
string

Global pinning targets prefix

Responses

Response samples

Content type
application/problem+json
"string"

Tag

Get list of tags

Authorizations:

Responses

Response samples

Content type
application/problem+json
"string"

Tag

Get list of tags

Authorizations:
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 1000 ]
Default: 100

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "tags":
    [
    ]
}

Create Tag

Authorizations:
Request Body schema: application/json
address
string ^[A-Fa-f0-9]{64}$

Responses

Response samples

Content type
application/json
{
  • "tags":
    [
    ]
}

Create Tag

Authorizations:
Request Body schema: application/json
address
string ^[A-Fa-f0-9]{64}$

Responses

Request samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "uid": 0,
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00",
  • "total": 0,
  • "processed": 0,
  • "synced": 0
}

Get Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Request samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "uid": 0,
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00",
  • "total": 0,
  • "processed": 0,
  • "synced": 0
}

Get Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Responses

Response samples

Content type
application/json
{
  • "uid": 0,
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00",
  • "total": 0,
  • "processed": 0,
  • "synced": 0
}

Delete Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Response samples

Content type
application/json
{
  • "uid": 0,
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00",
  • "total": 0,
  • "processed": 0,
  • "synced": 0
}

Delete Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Responses

Response samples

Content type
application/problem+json
"string"

Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Response samples

Content type
application/problem+json
"string"

Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Request Body schema: application/json

Can contain swarm hash to use for the tag

address
string ^[A-Fa-f0-9]{64}$

Responses

Request samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Chunk pinning

Pin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Request samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Chunk pinning

Pin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get pinning status of chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get pinning status of chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Update chunk pin counter

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Update chunk pin counter

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Get list of pinned chunks

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Get list of pinned chunks

Authorizations:
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 1000 ]
Default: 100

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "chunks":
    [
    ]
}

Bytes pinning

Pin bytes with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the bytes

+

Response samples

Content type
application/json
{
  • "chunks":
    [
    ]
}

Bytes pinning

Pin bytes with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the bytes

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin bytes chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the bytes

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin bytes chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the bytes

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

File pinning

Pin file with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the file

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

File pinning

Pin file with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the file

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin file chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the file

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin file chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the file

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Collection pinning

Pin collection with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the collection

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Collection pinning

Pin collection with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the collection

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin file chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the collection

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin file chunks with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of the collection

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Postal Service for Swarm

Send to recipient or target with Postal Service for Swarm

Authorizations:
path Parameters
topic
required
string

Topic name

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Postal Service for Swarm

Send to recipient or target with Postal Service for Swarm

Authorizations:
path Parameters
topic
required
string

Topic name

targets
required
string

Target message address prefix. If multiple targets are specified, only one would be matched.

query Parameters
recipient
string

Recipient publickey

Responses

Response samples

Content type
application/problem+json
"string"

Pss subscribe

Subscribe for messages on the given topic.

Authorizations:
path Parameters
topic
required
string

Topic name

+

Response samples

Content type
application/problem+json
"string"

Pss subscribe

Subscribe for messages on the given topic.

Authorizations:
path Parameters
topic
required
string

Topic name

Responses

Response samples

Content type
application/problem+json
"string"

Single owner chunk

Upload single owner chunk

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

+

Response samples

Content type
application/problem+json
"string"

Single owner chunk

Upload single owner chunk

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

id
required
string ^([A-Fa-f0-9]+)$
Example: cf880b8eeac5093fa27b0825906c600685

Id

query Parameters
sig
required
string ^([A-Fa-f0-9]+)$
Example: sig=cf880b8eeac5093fa27b0825906c600685

Signature

+
header Parameters
swarm-pin
boolean

Represents the pinning state of the chunk

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Feed

Create an initial feed root manifest

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Feed

Create an initial feed root manifest

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

topic
required
string ^([A-Fa-f0-9]+)$
Example: cf880b8eeac5093fa27b0825906c600685

Topic

query Parameters
type
string ^(sequence|epoch)$

Feed indexing scheme (default: sequence)

+
header Parameters
swarm-pin
boolean

Represents the pinning state of the chunk

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Find feed update

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Find feed update

Authorizations:
path Parameters
owner
required
string ^[A-Fa-f0-9]{40}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906

Owner

topic
required
string ^([A-Fa-f0-9]+)$
Example: cf880b8eeac5093fa27b0825906c600685

Topic

-
query Parameters
index
string ^([A-Fa-f0-9]+)$
Example: index=cf880b8eeac5093fa27b0825906c600685

Feed update index

-
at
integer

Timestamp of the update (default: now)

+
query Parameters
at
integer

Timestamp of the update (default: now)

type
string ^(sequence|epoch)$

Feed indexing scheme (default: sequence)

Responses

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}