Skip to content

M
mybee
Commit 1f76b641 authored by acud's avatar acud Committed by GitHub
Browse files
Options

lint openapi spec (#1209)

parent 1dc35eab
Show whitespace changes
Inline Side-by-side
Showing with 561 additions and 570 deletions
openapi/Swarm.yaml
View file @ 1f76b641
......@@ -3,46 +3,45 @@ openapi: 3.0.3
info:
version: 0.5.0
title: Swarm API
description: 'A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages'
description: "A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages"
security:
- {}
externalDocs:
description: Browse the documentation @ the Swarm Docs
url: 'https://docs.swarm.eth'
url: "https://docs.swarm.eth"
servers:
- url: 'http://{apiRoot}:{port}/v1'
- url: "http://{apiRoot}:{port}/v1"
variables:
apiRoot:
default: 'localhost'
default: "localhost"
description: Base address of the local bee node main API
port:
default: 1633
description: Service port provided in bee node config
- url: 'http://{apiRoot}:{port}'
- url: "http://{apiRoot}:{port}"
variables:
apiRoot:
default: 'localhost'
default: "localhost"
description: Base address of the local bee node main API
port:
default: 1633
description: Service port provided in bee node config
paths:
'/bytes':
"/bytes":
post:
summary: 'Upload data'
summary: "Upload data"
tags:
- Bytes
parameters:
- in: header
name: swarm-tag
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: false
description: Associate upload with an existing Tag UID
- in: header
......@@ -64,87 +63,87 @@ paths:
type: string
format: binary
responses:
'200':
"200":
description: Ok
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/bytes/{reference}':
"/bytes/{reference}":
get:
summary: 'Get referenced data'
summary: "Get referenced data"
tags:
- Bytes
parameters:
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address reference to content
responses:
'200':
"200":
description: Retrieved content specified by reference
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chunks/{reference}':
"/chunks/{reference}":
get:
summary: 'Get Chunk'
summary: "Get Chunk"
tags:
- Chunk
parameters:
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of chunk
responses:
'200':
"200":
description: Retrieved chunk content
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chunks':
"/chunks":
post:
summary: 'Upload Chunk'
summary: "Upload Chunk"
tags:
- Chunk
parameters:
- in: header
name: swarm-tag
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: false
description: Associate upload with an existing Tag UID
- in: header
......@@ -160,35 +159,35 @@ paths:
type: string
format: binary
responses:
'200':
"200":
description: Ok
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Status"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/files':
"/files":
post:
summary: 'Upload file'
summary: "Upload file"
tags:
- File
parameters:
- in: query
name: name
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/FileName'
$ref: "SwarmCommon.yaml#/components/schemas/FileName"
required: false
description: Filename
- in: header
name: swarm-tag
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: false
description: Associate upload with an existing Tag UID
- in: header
......@@ -223,60 +222,60 @@ paths:
type: string
format: binary
responses:
'200':
"200":
description: Ok
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/files/{reference}':
"/files/{reference}":
get:
summary: 'Get referenced file'
summary: "Get referenced file"
tags:
- File
parameters:
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of content
responses:
'200':
"200":
description: Ok
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/dirs':
"/dirs":
post:
summary: 'Upload a collection'
summary: "Upload a collection"
tags:
- Collection
parameters:
- in: header
name: swarm-tag
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: false
description: Associate upload with an existing Tag UID
- in: header
......@@ -312,31 +311,31 @@ paths:
type: string
format: binary
responses:
'200':
"200":
description: Ok
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/bzz/{reference}':
"/bzz/{reference}":
get:
summary: 'Get index document from a collection of files'
summary: "Get index document from a collection of files"
tags:
- Collection
parameters:
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of content
- in: query
......@@ -346,7 +345,7 @@ paths:
required: false
description: Global pinning targets prefix
responses:
'200':
"200":
description: Ok
content:
application/octet-stream:
......@@ -354,25 +353,25 @@ paths:
type: string
format: binary
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/bzz/{reference}/{path}':
"/bzz/{reference}/{path}":
get:
summary: 'Get referenced file from a collection of files'
summary: "Get referenced file from a collection of files"
tags:
- Collection
parameters:
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of content
- in: path
......@@ -388,7 +387,7 @@ paths:
required: false
description: Global pinning targets prefix
responses:
'200':
"200":
description: Ok
content:
application/octet-stream:
......@@ -396,35 +395,35 @@ paths:
type: string
format: binary
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/tags':
"/tags":
get:
summary: Get list of tags
tags:
- Tag
responses:
'200':
"200":
description: List of tags
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/TagsList'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/TagsList"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
post:
summary: 'Create Tag'
summary: "Create Tag"
tags:
- Tag
requestBody:
......@@ -432,81 +431,81 @@ paths:
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/NewTagRequest'
$ref: "SwarmCommon.yaml#/components/schemas/NewTagRequest"
responses:
'201':
"201":
description: New Tag Info
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/NewTagResponse'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/tags/{uid}':
"/tags/{uid}":
get:
summary: 'Get Tag information using Uid'
summary: "Get Tag information using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
responses:
'200':
"200":
description: Tag info
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/NewTagResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
delete:
summary: 'Delete Tag information using Uid'
summary: "Delete Tag information using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
responses:
'204':
$ref: 'SwarmCommon.yaml#/components/responses/204'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"204":
$ref: "SwarmCommon.yaml#/components/responses/204"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
patch:
summary: 'Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid'
summary: "Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
requestBody:
......@@ -515,29 +514,29 @@ paths:
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Address'
$ref: "SwarmCommon.yaml#/components/schemas/Address"
responses:
'200':
"200":
description: Ok
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Status"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/pin/chunks/{address}':
"/pin/chunks/{address}":
parameters:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of chunk
post:
......@@ -545,18 +544,18 @@ paths:
tags:
- Chunk pinning
responses:
'200':
"200":
description: Pinning chunk with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
delete:
......@@ -564,18 +563,18 @@ paths:
tags:
- Chunk pinning
responses:
'200':
"200":
description: Unpinning chunk with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
get:
......@@ -583,16 +582,16 @@ paths:
tags:
- Chunk pinning
responses:
'200':
"200":
description: Pinning state of chunk with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PinningState'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/PinningState"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
put:
......@@ -600,46 +599,46 @@ paths:
tags:
- Chunk pinning
responses:
'200':
"200":
description: Pinning state of chunk with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PinningState'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/PinningState"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
'/pin/chunks':
"/pin/chunks":
get:
summary: Get list of pinned chunks
tags:
- Chunk pinning
responses:
'200':
"200":
description: List of pinned chunks
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/BzzChunksPinned'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/BzzChunksPinned"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/pin/bytes/{address}':
"/pin/bytes/{address}":
parameters:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of the bytes
post:
......@@ -647,18 +646,18 @@ paths:
tags:
- Bytes pinning
responses:
'200':
"200":
description: Pinning bytes chunks with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
delete:
......@@ -666,27 +665,27 @@ paths:
tags:
- Bytes pinning
responses:
'200':
"200":
description: Unpinning chunk with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
'/pin/files/{address}':
"/pin/files/{address}":
parameters:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of the file
post:
......@@ -694,18 +693,18 @@ paths:
tags:
- File pinning
responses:
'200':
"200":
description: Pinning file chunks with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
delete:
......@@ -713,27 +712,27 @@ paths:
tags:
- File pinning
responses:
'200':
"200":
description: Unpinning file chunks with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
'/pin/bzz/{address}':
"/pin/bzz/{address}":
parameters:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of the collection
post:
......@@ -741,18 +740,18 @@ paths:
tags:
- Collection pinning
responses:
'200':
"200":
description: Pinning collection chunks (and all referenced files) with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
delete:
......@@ -760,22 +759,22 @@ paths:
tags:
- Collection pinning
responses:
'200':
"200":
description: Unpinning collection chunks (and all referenced files) with address
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
'/pss/send/{topic}/{targets}':
"/pss/send/{topic}/{targets}":
post:
summary: Send to recipient or target with Postal Service for Swarm
tags:
......@@ -784,32 +783,32 @@ paths:
- in: path
name: topic
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PssTopic'
$ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
required: true
description: Topic name
- in: path
name: targets
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PssTargets'
$ref: "SwarmCommon.yaml#/components/schemas/PssTargets"
required: true
description: Target message address prefix. If multiple targets are specified, only one would be matched.
- in: query
name: recipient
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PssRecipient'
$ref: "SwarmCommon.yaml#/components/schemas/PssRecipient"
required: false
description: Recipient publickey
responses:
'200':
"200":
description: Subscribed to topic
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/pss/subscribe/{topic}':
"/pss/subscribe/{topic}":
get:
summary: Subscribe for messages on the given topic.
tags:
......@@ -818,18 +817,18 @@ paths:
- in: path
name: topic
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/PssTopic'
$ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
required: true
description: Topic name
responses:
'200':
"200":
description: Returns a WebSocket with a subscription for incoming message data on the requested topic.
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/soc/{owner}/{id}':
"/soc/{owner}/{id}":
post:
summary: Upload single owner chunk
tags:
......@@ -838,38 +837,38 @@ paths:
- in: path
name: owner
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/EthereumAddress'
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Id
- in: query
name: sig
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Signature
responses:
'201':
"201":
description: Created
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'401':
$ref: 'SwarmCommon.yaml#/components/responses/401'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/feeds/{owner}/{topic}':
"/feeds/{owner}/{topic}":
post:
summary: Create an initial feed root manifest
tags:
......@@ -878,34 +877,34 @@ paths:
- in: path
name: owner
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/EthereumAddress'
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: topic
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Topic
- in: query
name: type
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/FeedType'
$ref: "SwarmCommon.yaml#/components/schemas/FeedType"
required: false
description: "Feed indexing scheme (default: sequence)"
responses:
'201':
"201":
description: Created
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'401':
$ref: 'SwarmCommon.yaml#/components/responses/401'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
get:
......@@ -916,19 +915,19 @@ paths:
- in: path
name: owner
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/EthereumAddress'
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: topic
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Topic
- in: query
name: index
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: false
description: Feed update index
- in: query
......@@ -940,28 +939,26 @@ paths:
- in: query
name: type
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/FeedType'
$ref: "SwarmCommon.yaml#/components/schemas/FeedType"
required: false
description: "Feed indexing scheme (default: sequence)"
responses:
'200':
"200":
description: Latest feed update
headers:
'swarm-feed-index':
$ref: 'SwarmCommon.yaml#/components/headers/SwarmFeedIndex'
'swarm-feed-index-next':
$ref: 'SwarmCommon.yaml#/components/headers/SwarmFeedIndexNext'
"swarm-feed-index":
$ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndex"
"swarm-feed-index-next":
$ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndexNext"
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ReferenceResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'401':
$ref: 'SwarmCommon.yaml#/components/responses/401'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
openapi/SwarmCommon.yaml
View file @ 1f76b641
......@@ -7,39 +7,38 @@ info:
externalDocs:
description: Browse the documentation @ the Swarm Docs
url: 'https://docs.swarm.eth'
url: "https://docs.swarm.eth"
paths: {}
components:
schemas:
Address:
type: object
properties:
address:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
Addresses:
type: object
properties:
overlay:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
underlay:
type: array
items:
$ref: '#/components/schemas/P2PUnderlay'
$ref: "#/components/schemas/P2PUnderlay"
ethereum:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
public_key:
$ref: '#/components/schemas/PublicKey'
$ref: "#/components/schemas/PublicKey"
pss_public_key:
$ref: '#/components/schemas/PublicKey'
$ref: "#/components/schemas/PublicKey"
Balance:
type: object
properties:
peer:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
balance:
type: integer
......@@ -49,7 +48,7 @@ components:
balances:
type: array
items:
$ref: '#/components/schemas/Balance'
$ref: "#/components/schemas/Balance"
BzzChunksPinned:
type: object
......@@ -68,7 +67,7 @@ components:
type: object
properties:
baseAddr:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
population:
type: integer
connected:
......@@ -97,9 +96,9 @@ components:
type: object
properties:
beneficiary:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
chequebook:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
payout:
type: integer
......@@ -109,17 +108,17 @@ components:
lastcheques:
type: array
items:
$ref: '#/components/schemas/ChequePeerResponse'
$ref: "#/components/schemas/ChequePeerResponse"
ChequePeerResponse:
type: object
properties:
peer:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
lastreceived:
$ref: '#/components/schemas/Cheque'
$ref: "#/components/schemas/Cheque"
lastsent:
$ref: '#/components/schemas/Cheque'
$ref: "#/components/schemas/Cheque"
ChequebookBalance:
type: object
......@@ -133,7 +132,7 @@ components:
type: object
properties:
chequebookaddress:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
DateTime:
type: string
......@@ -148,7 +147,7 @@ components:
EthereumAddress:
type: string
pattern: '^[A-Fa-f0-9]{40}$'
pattern: "^[A-Fa-f0-9]{40}$"
example: "36b7efd913ca4cf880b8eeac5093fa27b0825906"
FileName:
......@@ -158,11 +157,11 @@ components:
type: object
properties:
hash:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
HexString:
type: string
pattern: '^([A-Fa-f0-9]+)$'
pattern: "^([A-Fa-f0-9]+)$"
example: "cf880b8eeac5093fa27b0825906c600685"
MultiAddress:
......@@ -172,15 +171,15 @@ components:
type: object
properties:
address:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
NewTagResponse:
type: object
properties:
uid:
$ref: '#/components/schemas/Uid'
$ref: "#/components/schemas/Uid"
startedAt:
$ref: '#/components/schemas/DateTime'
$ref: "#/components/schemas/DateTime"
total:
type: integer
processed:
......@@ -204,11 +203,11 @@ components:
synced:
type: integer
uid:
$ref: '#/components/schemas/Uid'
$ref: "#/components/schemas/Uid"
address:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
startedAt:
$ref: '#/components/schemas/DateTime'
$ref: "#/components/schemas/DateTime"
TagsList:
type: object
......@@ -216,7 +215,7 @@ components:
tags:
type: array
items:
$ref: '#/components/schemas/NewTagResponse'
$ref: "#/components/schemas/NewTagResponse"
P2PUnderlay:
type: string
......@@ -228,13 +227,13 @@ components:
peers:
type: array
items:
$ref: '#/components/schemas/Address'
$ref: "#/components/schemas/Address"
PinningState:
type: object
properties:
address:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
pinCounter:
type: integer
......@@ -254,7 +253,7 @@ components:
type: object
properties:
reference:
$ref: '#/components/schemas/SwarmReference'
$ref: "#/components/schemas/SwarmReference"
Response:
type: object
......@@ -268,7 +267,7 @@ components:
type: object
properties:
rtt:
$ref: '#/components/schemas/Duration'
$ref: "#/components/schemas/Duration"
Status:
type: object
......@@ -296,21 +295,21 @@ components:
settlements:
type: array
items:
$ref: '#/components/schemas/Settlement'
$ref: "#/components/schemas/Settlement"
SwarmAddress:
type: string
pattern: '^[A-Fa-f0-9]{64}$'
pattern: "^[A-Fa-f0-9]{64}$"
example: "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
PublicKey:
type: string
pattern: '^[A-Fa-f0-9]{66}$'
pattern: "^[A-Fa-f0-9]{66}$"
example: "02ab7473879005929d10ce7d4f626412dad9fe56b0a6622038931d26bd79abf0a4"
SwarmEncryptedReference:
type: string
pattern: '^[A-Fa-f0-9]{128}$'
pattern: "^[A-Fa-f0-9]{128}$"
example: "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f2d2810619d29b5dbefd5d74abce25d58b81b251baddb9c3871cf0d6967deaae2"
DomainName:
......@@ -320,20 +319,20 @@ components:
SwarmOnlyReference:
oneOf:
- $ref: '#/components/schemas/SwarmAddress'
- $ref: '#/components/schemas/SwarmEncryptedReference'
- $ref: "#/components/schemas/SwarmAddress"
- $ref: "#/components/schemas/SwarmEncryptedReference"
SwarmReference:
oneOf:
- $ref: '#/components/schemas/SwarmAddress'
- $ref: '#/components/schemas/SwarmEncryptedReference'
- $ref: '#/components/schemas/DomainName'
- $ref: "#/components/schemas/SwarmAddress"
- $ref: "#/components/schemas/SwarmEncryptedReference"
- $ref: "#/components/schemas/DomainName"
SwapCashoutResult:
type: object
properties:
recipient:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
lastPayout:
type: integer
bounced:
......@@ -343,31 +342,31 @@ components:
type: object
properties:
peer:
$ref: '#/components/schemas/SwarmAddress'
$ref: "#/components/schemas/SwarmAddress"
chequebook:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
cumulativePayout:
type: integer
beneficiary:
$ref: '#/components/schemas/EthereumAddress'
$ref: "#/components/schemas/EthereumAddress"
transactionHash:
$ref: '#/components/schemas/TransactionHash'
$ref: "#/components/schemas/TransactionHash"
result:
$ref: '#/components/schemas/SwapCashoutResult'
$ref: "#/components/schemas/SwapCashoutResult"
TagName:
type: string
TransactionHash:
type: string
pattern: '^[A-Fa-f0-9]{64}$'
pattern: "^[A-Fa-f0-9]{64}$"
example: "e28a34ffe7b1710c1baf97ca6d71d81b7f159a9920910876856c8d94dd7be4ae"
TransactionResponse:
type: object
properties:
transactionHash:
$ref: '#/components/schemas/TransactionHash'
$ref: "#/components/schemas/TransactionHash"
Uid:
type: integer
......@@ -380,52 +379,48 @@ components:
FeedType:
type: string
pattern: '^(sequence|epoch)$'
pattern: "^(sequence|epoch)$"
headers:
SwarmFeedIndex:
description: 'The index of the found update'
description: "The index of the found update"
schema:
$ref: '#/components/schemas/HexString'
$ref: "#/components/schemas/HexString"
SwarmFeedIndexNext:
description: 'The index of the next possible update'
description: "The index of the next possible update"
schema:
$ref: '#/components/schemas/HexString'
$ref: "#/components/schemas/HexString"
responses:
'204':
"204":
description: The resource was deleted successfully.
'400':
"400":
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
$ref: "#/components/schemas/ProblemDetails"
"401":
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
$ref: "#/components/schemas/ProblemDetails"
"403":
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
$ref: "#/components/schemas/ProblemDetails"
"404":
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
$ref: "#/components/schemas/ProblemDetails"
"500":
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
$ref: "#/components/schemas/ProblemDetails"
openapi/SwarmDebug.yaml
View file @ 1f76b641
......@@ -2,62 +2,61 @@ openapi: 3.0.3
info:
version: 0.5.0
title: Bee Debug API
description: 'A list of the currently provided debug interfaces to interact with the bee node'
description: "A list of the currently provided debug interfaces to interact with the bee node"
security:
- {}
externalDocs:
description: Browse the documentation @ the Swarm Docs
url: 'https://docs.swarm.eth'
url: "https://docs.swarm.eth"
servers:
- url: 'http://{apiRoot}:{port}'
- url: "http://{apiRoot}:{port}"
variables:
apiRoot:
default: 'localhost'
default: "localhost"
description: Base address of the local bee node debug API
port:
default: 1635
description: Service port provided in bee node config
paths:
'/addresses':
"/addresses":
get:
summary: Get overlay and underlay addresses of the node
tags:
- Connectivity
responses:
'200':
"200":
description: Own node underlay and overlay addresses
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Addresses'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Addresses"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/balances':
"/balances":
get:
summary: Get the balances with all known peers including prepaid services
tags:
- Balance
responses:
'200':
"200":
description: Own balances with all known peers
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Balances'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Balances"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/balances/{address}':
"/balances/{address}":
get:
summary: Get the balances with a specific peer including prepaid services
tags:
......@@ -66,58 +65,58 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
'200':
"200":
description: Balance with the specific peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Balance'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Balance"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/blocklist':
"/blocklist":
get:
summary: Get a list of blocklisted peers
tags:
- Connectivity
responses:
'200':
"200":
description: Returns overlay addresses of blocklisted peers
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Peers'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Peers"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/consumed':
"/consumed":
get:
summary: Get the past due consumption balances with all known peers
tags:
- Balance
responses:
'200':
"200":
description: Own past due consumption balances with all known peers
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Balances'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Balances"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/consumed/{address}':
"/consumed/{address}":
get:
summary: Get the past due consumption balance with a specific peer
tags:
......@@ -126,54 +125,54 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
'200':
"200":
description: Past-due consumption balance with the specific peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Balance'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Balance"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/address':
"/chequebook/address":
get:
summary: Get the address of the chequebook contract used
tags:
- Chequebook
responses:
'200':
"200":
description: Ethereum address of chequebook contract
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ChequebookAddress'
$ref: "SwarmCommon.yaml#/components/schemas/ChequebookAddress"
'/chequebook/balance':
"/chequebook/balance":
get:
summary: Get the balance of the chequebook
tags:
- Chequebook
responses:
'200':
"200":
description: Balance of the chequebook
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ChequebookBalance'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ChequebookBalance"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chunks/{address}':
"/chunks/{address}":
get:
summary: Check if chunk at address exists locally
tags:
......@@ -182,20 +181,20 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of chunk
responses:
'200':
"200":
description: Chunk exists
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
delete:
......@@ -206,24 +205,24 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of chunk
responses:
'200':
"200":
description: Chunk exists
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
default:
description: Default response
'/connect/{multiAddress}':
"/connect/{multiAddress}":
post:
summary: Connect to address
tags:
......@@ -233,54 +232,54 @@ paths:
allowReserved: true
name: multiAddress
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/MultiAddress'
$ref: "SwarmCommon.yaml#/components/schemas/MultiAddress"
required: true
description: Underlay address of peer
responses:
'200':
"200":
description: Returns overlay address of connected peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Address'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Address"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/health':
"/health":
get:
summary: Get health of node
tags:
- Status
responses:
'200':
"200":
description: Health State of node
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
$ref: "SwarmCommon.yaml#/components/schemas/Status"
default:
description: Default response
'/peers':
"/peers":
get:
summary: Get a list of peers
tags:
- Connectivity
responses:
'200':
"200":
description: Returns overlay addresses of connected peers
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Peers'
$ref: "SwarmCommon.yaml#/components/schemas/Peers"
default:
description: Default response
'/peers/{address}':
"/peers/{address}":
delete:
summary: Remove peer
tags:
......@@ -289,24 +288,24 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
'200':
"200":
description: Disconnected peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Response'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/pingpong/{peer-id}':
"/pingpong/{peer-id}":
post:
summary: Try connection to node
tags:
......@@ -315,41 +314,41 @@ paths:
- in: path
name: peer-id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
'200':
"200":
description: Returns round trip time for given peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/RttMs'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/RttMs"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/readiness':
"/readiness":
get:
summary: Get readiness state of node
tags:
- Status
responses:
'200':
"200":
description: Health State of node
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
$ref: "SwarmCommon.yaml#/components/schemas/Status"
default:
description: Default response
'/settlements/{address}':
"/settlements/{address}":
get:
summary: Get amount of sent and received from settlements with a peer
tags:
......@@ -358,67 +357,67 @@ paths:
- in: path
name: address
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
'200':
"200":
description: Amount of sent or received from settlements with a peer
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Settlement'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Settlement"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/settlements':
"/settlements":
get:
summary: Get settlements with all known peers and total amount sent or received
tags:
- Settlements
responses:
'200':
"200":
description: Settlements with all known peers and total amount sent or received
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Settlements'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Settlements"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/topology':
"/topology":
get:
description: Get topology of known network
tags:
- Connectivity
responses:
'200':
"200":
description: Swarm topology of the bee node
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/BzzTopology'
$ref: "SwarmCommon.yaml#/components/schemas/BzzTopology"
'/welcome-message':
"/welcome-message":
get:
summary: Get configured P2P welcome message
tags:
- Connectivity
responses:
'200':
"200":
description: Welcome message
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/WelcomeMessage'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/WelcomeMessage"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
post:
......@@ -429,44 +428,44 @@ paths:
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/WelcomeMessage'
$ref: "SwarmCommon.yaml#/components/schemas/WelcomeMessage"
responses:
'200':
"200":
description: OK
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/Status"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/cashout/{peer-id}':
"/chequebook/cashout/{peer-id}":
get:
summary: Get last cashout action for the peer
parameters:
- in: path
name: peer-id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
tags:
- Chequebook
responses:
'200':
"200":
description: Cashout status
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwapCashoutStatus'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/SwapCashoutStatus"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
post:
......@@ -475,71 +474,71 @@ paths:
- in: path
name: peer-id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
tags:
- Chequebook
responses:
'200':
"200":
description: OK
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/TransactionResponse'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/cheque/{peer-id}':
"/chequebook/cheque/{peer-id}":
get:
summary: Get last cheques for the peer
parameters:
- in: path
name: peer-id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmAddress'
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
tags:
- Chequebook
responses:
'200':
"200":
description: Last cheques
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ChequePeerResponse'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ChequePeerResponse"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/cheque':
"/chequebook/cheque":
get:
summary: Get last cheques for all peers
tags:
- Chequebook
responses:
'200':
"200":
description: Last cheques
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/ChequeAllPeersResponse'
'404':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/ChequeAllPeersResponse"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/deposit':
"/chequebook/deposit":
post:
summary: Deposit tokens from overlay address into chequebook
parameters:
......@@ -552,20 +551,20 @@ paths:
tags:
- Chequebook
responses:
'200':
"200":
description: Transaction hash of the deposit transaction
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/TransactionResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/chequebook/withdraw':
"/chequebook/withdraw":
post:
summary: Withdraw tokens from the chequebook to the overlay address
parameters:
......@@ -578,43 +577,43 @@ paths:
tags:
- Chequebook
responses:
'200':
"200":
description: Transaction hash of the withdraw transaction
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/TransactionResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/404'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
'/tags/{uid}':
"/tags/{uid}":
get:
summary: 'Get Tag information using Uid'
summary: "Get Tag information using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/Uid'
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
responses:
'200':
"200":
description: Tag info
content:
application/json:
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/NewTagDebugResponse'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
$ref: "SwarmCommon.yaml#/components/schemas/NewTagDebugResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"403":
$ref: "SwarmCommon.yaml#/components/responses/403"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment