Commit 68615c77 authored by metacertain's avatar metacertain Committed by GitHub

OpenAPI spec updates (#1189)

parent e0f50061
openapi: 3.0.0
openapi: 3.0.3
info:
version: 0.4.0
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'
......@@ -134,6 +134,8 @@ paths:
$ref: 'SwarmCommon.yaml#/components/responses/500'
default:
description: Default response
'/chunks':
post:
summary: 'Upload Chunk'
tags:
......@@ -151,12 +153,6 @@ paths:
type: boolean
required: false
description: Represents the pinning state of the chunk
- in: path
name: reference
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/SwarmReference'
required: true
description: Swarm address of chunk
requestBody:
content:
application/octet-stream:
......@@ -172,8 +168,6 @@ paths:
$ref: 'SwarmCommon.yaml#/components/schemas/Status'
'400':
$ref: 'SwarmCommon.yaml#/components/responses/400'
'403':
$ref: 'SwarmCommon.yaml#/components/responses/403'
'500':
$ref: 'SwarmCommon.yaml#/components/responses/500'
default:
......@@ -835,3 +829,43 @@ paths:
default:
description: Default response
'/soc/{owner}/{id}':
post:
summary: Upload single owner chunk
tags:
- Single owner chunk
parameters:
- in: path
name: owner
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/EthereumAddress'
required: true
description: Owner
- in: path
name: id
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
required: true
description: Id
- in: query
name: sig
schema:
$ref: 'SwarmCommon.yaml#/components/schemas/HexString'
required: true
description: Signature
responses:
'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'
default:
description: Default response
openapi: 3.0.0
openapi: 3.0.3
info:
version: 0.4.0
version: 0.5.0
title: Common Data Types
description: |
\*****bzzz*****
......@@ -138,7 +138,7 @@ components:
DateTime:
type: string
format: date-time
pattern: '^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{7}\+\d{2}:\d{2})$'
#pattern: '^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{7}\+\d{2}:\d{2})$'
example: "2020-06-11T11:26:42.6969797+02:00"
Duration:
......@@ -160,6 +160,11 @@ components:
hash:
$ref: '#/components/schemas/SwarmAddress'
HexString:
type: string
pattern: '^([A-Fa-f0-9]+)$'
example: "cf880b8eeac5093fa27b0825906c600685"
MultiAddress:
type: string
......@@ -378,6 +383,12 @@ components:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
......
openapi: 3.0.0
openapi: 3.0.3
info:
version: 0.4.0
version: 0.5.0
title: Bee Debug API
description: 'A list of the currently provided debug interfaces to interact with the bee node'
......@@ -83,6 +83,23 @@ paths:
default:
description: Default response
'/blocklist':
get:
summary: Get a list of blocklisted peers
tags:
- Connectivity
responses:
'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'
default:
description: Default response
'/consumed':
get:
summary: Get the past due consumption balances with all known peers
......
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