github.com/ethersphere/bee/v2@v2.2.0/openapi/Swarm.yaml (about)

     1  openapi: 3.0.3
     2  
     3  info:
     4    version: 7.1.0
     5    title: Bee API
     6    description: "A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages"
     7  
     8  security:
     9    - {}
    10  
    11  externalDocs:
    12    description: Browse the documentation @ the Swarm Docs
    13    url: "https://docs.ethswarm.org"
    14  
    15  servers:
    16    - url: "http://{apiRoot}:{port}/v1"
    17      variables:
    18        apiRoot:
    19          default: "localhost"
    20          description: Base address of the local bee node main API
    21        port:
    22          default: "1633"
    23          description: Service port provided in bee node config
    24    - url: "http://{apiRoot}:{port}"
    25      variables:
    26        apiRoot:
    27          default: "localhost"
    28          description: Base address of the local bee node main API
    29        port:
    30          default: "1633"
    31          description: Service port provided in bee node config
    32  
    33  paths:
    34    "/grantee":
    35      post:
    36        summary: "Create grantee list"
    37        tags:
    38          - ACT
    39        parameters:
    40          - in: header
    41            schema:
    42              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
    43            name: swarm-postage-batch-id
    44            required: true
    45          - in: header
    46            schema:
    47              $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
    48            name: swarm-tag
    49            required: false
    50          - in: header
    51            schema:
    52              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
    53            name: swarm-pin
    54            required: false
    55          - in: header
    56            schema:
    57              $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
    58            name: swarm-deferred-upload
    59            required: false
    60          - in: header
    61            schema:
    62              $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
    63            name: swarm-act-history-address
    64            required: false
    65        requestBody:
    66          required: true
    67          content:
    68            application/json:
    69              schema:
    70                $ref: "SwarmCommon.yaml#/components/schemas/ActGranteesCreateRequest"
    71        responses:
    72          "201":
    73            description: Ok
    74            content:
    75              application/json:
    76                schema:
    77                  $ref: "SwarmCommon.yaml#/components/schemas/ActGranteesOperationResponse"
    78          "400":
    79            $ref: "SwarmCommon.yaml#/components/responses/400"
    80          "500":
    81            $ref: "SwarmCommon.yaml#/components/responses/500"
    82  
    83    "/grantee/{reference}":
    84      get:
    85        summary: "Get grantee list"
    86        tags:
    87          - ACT
    88        parameters:
    89          - in: path
    90            name: reference
    91            schema:
    92              $ref: "SwarmCommon.yaml#/components/schemas/SwarmEncryptedReference"
    93            required: true
    94            description: Grantee list reference
    95        responses:
    96          "200":
    97            description: Ok
    98            content:
    99              application/json:
   100                schema:
   101                  type: array
   102                  items:
   103                    $ref: "SwarmCommon.yaml#/components/schemas/PublicKey"
   104          "404":
   105            $ref: "SwarmCommon.yaml#/components/responses/404"
   106          "500":
   107            $ref: "SwarmCommon.yaml#/components/responses/500"
   108      patch:
   109        summary: "Update grantee list"
   110        description: "Add or remove grantees from an existing grantee list"
   111        tags:
   112          - ACT
   113        parameters:
   114          - in: path
   115            name: reference
   116            schema:
   117              $ref: "SwarmCommon.yaml#/components/schemas/SwarmEncryptedReference"
   118            required: true
   119            description: Grantee list reference
   120          - in: header
   121            schema:
   122              $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   123            name: swarm-act-history-address
   124            required: true
   125          - in: header
   126            schema:
   127              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   128            name: swarm-postage-batch-id
   129            required: true
   130          - in: header
   131            schema:
   132              $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
   133            name: swarm-tag
   134            required: false
   135          - in: header
   136            schema:
   137              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
   138            name: swarm-pin
   139            required: false
   140          - in: header
   141            schema:
   142              $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
   143            name: swarm-deferred-upload
   144            required: false
   145        requestBody:
   146          required: true
   147          content:
   148            application/json:
   149              schema:
   150                $ref: "SwarmCommon.yaml#/components/schemas/ActGranteesPatchRequest"
   151        responses:
   152          "200":
   153            description: Ok
   154            content:
   155              application/json:
   156                schema:
   157                  $ref: "SwarmCommon.yaml#/components/schemas/ActGranteesOperationResponse"
   158          "400":
   159            $ref: "SwarmCommon.yaml#/components/responses/400"
   160          "500":
   161            $ref: "SwarmCommon.yaml#/components/responses/500"
   162  
   163    "/bytes":
   164      post:
   165        summary: "Upload data"
   166        tags:
   167          - Bytes
   168        parameters:
   169          - in: header
   170            schema:
   171              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   172            name: swarm-postage-batch-id
   173            required: true
   174          - in: header
   175            schema:
   176              $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
   177            name: swarm-tag
   178            required: false
   179          - in: header
   180            schema:
   181              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
   182            name: swarm-pin
   183            required: false
   184          - in: header
   185            schema:
   186              $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
   187            name: swarm-deferred-upload
   188            required: false
   189          - in: header
   190            schema:
   191              $ref: "SwarmCommon.yaml#/components/parameters/SwarmEncryptParameter"
   192            name: swarm-encrypt
   193            required: false
   194          - in: header
   195            schema:
   196              $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyLevelParameter"
   197            name: swarm-redundancy-level
   198            required: false
   199  
   200        requestBody:
   201          content:
   202            application/octet-stream:
   203              schema:
   204                type: string
   205                format: binary
   206        responses:
   207          "201":
   208            description: Ok
   209            headers:
   210              "swarm-tag":
   211                $ref: "SwarmCommon.yaml#/components/headers/SwarmTag"
   212            content:
   213              application/json:
   214                schema:
   215                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   216          "400":
   217            $ref: "SwarmCommon.yaml#/components/responses/400"
   218          "402":
   219            $ref: "SwarmCommon.yaml#/components/responses/402"
   220          "500":
   221            $ref: "SwarmCommon.yaml#/components/responses/500"
   222          default:
   223            description: Default response
   224  
   225    "/bytes/{reference}":
   226      get:
   227        summary: "Get referenced data"
   228        tags:
   229          - Bytes
   230        parameters:
   231          - in: path
   232            name: reference
   233            schema:
   234              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
   235            required: true
   236            description: Swarm address reference to content
   237          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
   238          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyStrategyParameter"
   239          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyFallbackModeParameter"
   240          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmChunkRetrievalTimeoutParameter"
   241          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
   242          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
   243          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   244        responses:
   245          "200":
   246            description: Retrieved content specified by reference
   247            content:
   248              application/octet-stream:
   249                schema:
   250                  type: string
   251                  format: binary
   252          "400":
   253            $ref: "SwarmCommon.yaml#/components/responses/400"
   254          default:
   255            description: Default response
   256      head:
   257        summary: Requests the headers containing the content type and length for the reference
   258        tags:
   259          - Bytes
   260        parameters:
   261          - in: path
   262            name: address
   263            schema:
   264              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
   265            required: true
   266            description: Swarm address of chunk
   267          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
   268          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
   269          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   270        responses:
   271          "200":
   272            description: Chunk exists
   273          "400":
   274            $ref: "SwarmCommon.yaml#/components/responses/400"
   275          "404":
   276            $ref: "SwarmCommon.yaml#/components/responses/404"
   277          default:
   278            description: Default response
   279  
   280    "/chunks":
   281      post:
   282        summary: "Upload chunk"
   283        tags:
   284          - Chunk
   285        parameters:
   286          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
   287          - in: header
   288            name: swarm-postage-batch-id
   289            schema:
   290              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   291            required: false
   292          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageStamp"
   293          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmAct"
   294          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   295        requestBody:
   296          description: Chunk binary data that has to have at least 8 bytes.
   297          content:
   298            application/octet-stream:
   299              schema:
   300                type: string
   301                format: binary
   302        responses:
   303          "201":
   304            description: Ok
   305            headers:
   306              "swarm-tag":
   307                description: Tag UID if it was passed to the request `swarm-tag` header.
   308                schema:
   309                  $ref: "SwarmCommon.yaml#/components/schemas/Uid"
   310              "swarm-act-history-address":
   311                $ref: "SwarmCommon.yaml#/components/headers/SwarmActHistoryAddress"
   312            content:
   313              application/json:
   314                schema:
   315                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   316          "400":
   317            $ref: "SwarmCommon.yaml#/components/responses/400"
   318          "402":
   319            $ref: "SwarmCommon.yaml#/components/responses/402"
   320          "500":
   321            $ref: "SwarmCommon.yaml#/components/responses/500"
   322          default:
   323            description: Default response
   324  
   325    "/chunks/stream":
   326      get:
   327        summary: "Upload stream of chunks"
   328        description: "Returns a WebSocket connection on which stream of chunks can be uploaded. Each chunk sent is acknowledged using a binary response `0` which serves as confirmation of upload of single chunk. Chunks should be packaged as binary messages for uploading. If a tag is specified, the chunks will be streamed into local storage and then be uploaded to the network once the stream is closed. If a tag is not specified, the chunks will bypass local storage and be directly uploaded to the network through the stream as they arrive."
   329        tags:
   330          - Chunk
   331        parameters:
   332          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
   333          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   334        responses:
   335          "200":
   336            description: "Connection established"
   337          "400":
   338            $ref: "SwarmCommon.yaml#/components/responses/400"
   339          default:
   340            description: Default response
   341    "/bzz":
   342      post:
   343        summary: "Upload file or a collection of files"
   344        description:
   345          "In order to upload a collection, user can send a multipart request with all the files populated in the form data with appropriate headers.\n\n
   346          User can also upload a tar file along with the swarm-collection header. This will upload the tar file after extracting the entire directory structure.\n\n
   347          If the swarm-collection header is absent, all requests (including tar files) are considered as single file uploads.\n\n
   348          A multipart request is treated as a collection regardless of whether the swarm-collection header is present. This means in order to serve single files
   349          uploaded as a multipart request, the swarm-index-document header should be used with the name of the file."
   350        tags:
   351          - BZZ
   352        parameters:
   353          - in: query
   354            name: name
   355            schema:
   356              $ref: "SwarmCommon.yaml#/components/schemas/FileName"
   357            required: false
   358            description: Filename when uploading single file
   359          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
   360          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
   361          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmEncryptParameter"
   362          - $ref: "SwarmCommon.yaml#/components/parameters/ContentTypePreserved"
   363          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmCollection"
   364          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmIndexDocumentParameter"
   365          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmErrorDocumentParameter"
   366          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   367          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
   368          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyLevelParameter"
   369          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmAct"
   370          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   371        requestBody:
   372          content:
   373            multipart/form-data:
   374              schema:
   375                properties:
   376                  file:
   377                    type: array
   378                    items:
   379                      type: string
   380                      format: binary
   381            application/octet-stream:
   382              schema:
   383                type: string
   384                format: binary
   385            application/x-tar:
   386              schema:
   387                type: string
   388                format: binary
   389        responses:
   390          "201":
   391            description: Ok
   392            headers:
   393              "swarm-tag":
   394                $ref: "SwarmCommon.yaml#/components/headers/SwarmTag"
   395              "etag":
   396                $ref: "SwarmCommon.yaml#/components/headers/ETag"
   397              "swarm-act-history-address":
   398                $ref: "SwarmCommon.yaml#/components/headers/SwarmActHistoryAddress"
   399            content:
   400              application/json:
   401                schema:
   402                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   403          "400":
   404            $ref: "SwarmCommon.yaml#/components/responses/400"
   405          "402":
   406            $ref: "SwarmCommon.yaml#/components/responses/402"
   407          "500":
   408            $ref: "SwarmCommon.yaml#/components/responses/500"
   409          default:
   410            description: Default response
   411  
   412    "/bzz/{reference}":
   413      get:
   414        summary: "Get file or index document from a collection of files"
   415        tags:
   416          - BZZ
   417        parameters:
   418          - in: path
   419            name: reference
   420            schema:
   421              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
   422            required: true
   423            description: Swarm address of content
   424          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
   425          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyStrategyParameter"
   426          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyFallbackModeParameter"
   427          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmChunkRetrievalTimeoutParameter"
   428          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
   429          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
   430          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   431        responses:
   432          "200":
   433            description: Ok
   434            # "swarm-feed-index":
   435            #   $ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndex"
   436            content:
   437              application/octet-stream:
   438                schema:
   439                  type: string
   440                  format: binary
   441          "400":
   442            $ref: "SwarmCommon.yaml#/components/responses/400"
   443          "404":
   444            $ref: "SwarmCommon.yaml#/components/responses/404"
   445          "500":
   446            $ref: "SwarmCommon.yaml#/components/responses/500"
   447          default:
   448            description: Default response
   449      head:
   450        summary: Get the headers containing the content type and length for the reference
   451        tags:
   452          - BZZ
   453        parameters:
   454          - in: path
   455            name: address
   456            schema:
   457              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
   458            required: true
   459            description: Swarm address of chunk
   460          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
   461          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
   462          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   463        responses:
   464          "200":
   465            description: Chunk exists
   466          "400":
   467            $ref: "SwarmCommon.yaml#/components/responses/400"
   468          "404":
   469            $ref: "SwarmCommon.yaml#/components/responses/404"
   470          default:
   471            description: Default response
   472  
   473    "/bzz/{reference}/{path}":
   474      get:
   475        summary: "Get referenced file from a collection of files"
   476        tags:
   477          - BZZ
   478        parameters:
   479          - in: path
   480            name: reference
   481            schema:
   482              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
   483            required: true
   484            description: Swarm address of content
   485          - in: path
   486            name: path
   487            schema:
   488              type: string
   489            required: true
   490            description: Path to the file in the collection.
   491          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyStrategyParameter"
   492          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmRedundancyFallbackModeParameter"
   493          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmChunkRetrievalTimeoutParameter"
   494        responses:
   495          "200":
   496            description: Ok
   497            content:
   498              application/octet-stream:
   499                schema:
   500                  type: string
   501                  format: binary
   502  
   503          "400":
   504            $ref: "SwarmCommon.yaml#/components/responses/400"
   505          "404":
   506            $ref: "SwarmCommon.yaml#/components/responses/404"
   507          "500":
   508            $ref: "SwarmCommon.yaml#/components/responses/500"
   509          default:
   510            description: Default response
   511  
   512    "/tags":
   513      get:
   514        summary: Get list of tags
   515        tags:
   516          - Tag
   517        parameters:
   518          - in: query
   519            name: offset
   520            schema:
   521              type: integer
   522              minimum: 0
   523              default: 0
   524            required: false
   525            description: The number of items to skip before starting to collect the result set.
   526          - in: query
   527            name: limit
   528            schema:
   529              type: integer
   530              minimum: 1
   531              maximum: 1000
   532              default: 100
   533            required: false
   534            description: The numbers of items to return.
   535        responses:
   536          "200":
   537            description: List of tags
   538            content:
   539              application/json:
   540                schema:
   541                  $ref: "SwarmCommon.yaml#/components/schemas/TagsList"
   542          "500":
   543            $ref: "SwarmCommon.yaml#/components/responses/500"
   544          default:
   545            description: Default response
   546      post:
   547        summary: "Create Tag"
   548        tags:
   549          - Tag
   550        description: Tags can be thought of as upload sessions which can be tracked using the tags endpoint. It will keep track of the chunks that are uploaded as part of the tag and will push them out to the network once a done split is called on the Tag. This happens internally if you use the `Swarm-Deferred-Upload` header.
   551        requestBody:
   552          required: true
   553          content:
   554            application/json:
   555              schema:
   556                $ref: "SwarmCommon.yaml#/components/schemas/NewTagRequest"
   557        responses:
   558          "201":
   559            description: New Tag Info
   560            content:
   561              application/json:
   562                schema:
   563                  $ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
   564  
   565          "500":
   566            $ref: "SwarmCommon.yaml#/components/responses/500"
   567          default:
   568            description: Default response
   569  
   570    "/tags/{uid}":
   571      get:
   572        summary: "Get Tag information using Uid"
   573        tags:
   574          - Tag
   575        parameters:
   576          - in: path
   577            name: uid
   578            schema:
   579              $ref: "SwarmCommon.yaml#/components/schemas/Uid"
   580            required: true
   581            description: Uid
   582        responses:
   583          "200":
   584            description: Tag info
   585            content:
   586              application/json:
   587                schema:
   588                  $ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
   589          "400":
   590            $ref: "SwarmCommon.yaml#/components/responses/400"
   591          "404":
   592            $ref: "SwarmCommon.yaml#/components/responses/404"
   593          "500":
   594            $ref: "SwarmCommon.yaml#/components/responses/500"
   595          default:
   596            description: Default response
   597      delete:
   598        summary: "Delete Tag information using Uid"
   599        tags:
   600          - Tag
   601        parameters:
   602          - in: path
   603            name: uid
   604            schema:
   605              $ref: "SwarmCommon.yaml#/components/schemas/Uid"
   606            required: true
   607            description: Uid
   608        responses:
   609          "204":
   610            $ref: "SwarmCommon.yaml#/components/responses/204"
   611          "400":
   612            $ref: "SwarmCommon.yaml#/components/responses/400"
   613          "404":
   614            $ref: "SwarmCommon.yaml#/components/responses/404"
   615          "500":
   616            $ref: "SwarmCommon.yaml#/components/responses/500"
   617          default:
   618            description: Default response
   619      patch:
   620        summary: "Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid"
   621        tags:
   622          - Tag
   623        parameters:
   624          - in: path
   625            name: uid
   626            schema:
   627              $ref: "SwarmCommon.yaml#/components/schemas/Uid"
   628            required: true
   629            description: Uid
   630        requestBody:
   631          description: Can contain swarm hash to use for the tag
   632          required: false
   633          content:
   634            application/json:
   635              schema:
   636                $ref: "SwarmCommon.yaml#/components/schemas/Address"
   637        responses:
   638          "200":
   639            description: Ok
   640            content:
   641              application/json:
   642                schema:
   643                  $ref: "SwarmCommon.yaml#/components/schemas/HealthStatus"
   644          "404":
   645            $ref: "SwarmCommon.yaml#/components/responses/404"
   646          "500":
   647            $ref: "SwarmCommon.yaml#/components/responses/500"
   648          default:
   649            description: Default response
   650  
   651    "/pins/{reference}":
   652      parameters:
   653        - in: path
   654          name: reference
   655          schema:
   656            $ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
   657          required: true
   658          description: Swarm reference of the root hash
   659      post:
   660        summary: Pin the root hash with the given reference
   661        tags:
   662          - Pinning
   663        responses:
   664          "200":
   665            description: Pin already exists, so no operation
   666            content:
   667              application/json:
   668                schema:
   669                  $ref: "SwarmCommon.yaml#/components/schemas/Response"
   670          "201":
   671            description: New pin with root reference was created
   672            content:
   673              application/json:
   674                schema:
   675                  $ref: "SwarmCommon.yaml#/components/schemas/Response"
   676          "400":
   677            $ref: "SwarmCommon.yaml#/components/responses/400"
   678          "404":
   679            $ref: "SwarmCommon.yaml#/components/responses/404"
   680          "500":
   681            $ref: "SwarmCommon.yaml#/components/responses/500"
   682          default:
   683            description: Default response
   684      delete:
   685        summary: Unpin the root hash with the given reference
   686        tags:
   687          - Pinning
   688        responses:
   689          "200":
   690            description: Unpinning root hash with reference
   691            content:
   692              application/json:
   693                schema:
   694                  $ref: "SwarmCommon.yaml#/components/schemas/Response"
   695          "400":
   696            $ref: "SwarmCommon.yaml#/components/responses/400"
   697          "500":
   698            $ref: "SwarmCommon.yaml#/components/responses/500"
   699          default:
   700            description: Default response
   701      get:
   702        summary: Get pinning status of the root hash with the given reference
   703        tags:
   704          - Pinning
   705        responses:
   706          "200":
   707            description: Reference of the pinned root hash
   708            content:
   709              application/json:
   710                schema:
   711                  $ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
   712          "400":
   713            $ref: "SwarmCommon.yaml#/components/responses/400"
   714          "404":
   715            $ref: "SwarmCommon.yaml#/components/responses/404"
   716          "500":
   717            $ref: "SwarmCommon.yaml#/components/responses/500"
   718          default:
   719            description: Default response
   720  
   721    "/pins":
   722      get:
   723        summary: Get the list of pinned root hash references
   724        tags:
   725          - Pinning
   726        responses:
   727          "200":
   728            description: List of pinned root hash references
   729            content:
   730              application/json:
   731                schema:
   732                  $ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReferencesList"
   733          "500":
   734            $ref: "SwarmCommon.yaml#/components/responses/500"
   735          default:
   736            description: Default response
   737  
   738    "/pins/check":
   739      get:
   740        summary: Validate pinned chunks integerity
   741        tags:
   742          - Pinning
   743        parameters:
   744          - in: query
   745            name: ref
   746            schema:
   747              $ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
   748            required: false
   749            description: The number of items to skip before starting to collect the result set.
   750        responses:
   751          "200":
   752            description: List of checked root hash references
   753            content:
   754              application/json:
   755                schema:
   756                  $ref: "SwarmCommon.yaml#/components/schemas/PinCheckResponse"
   757          "500":
   758            $ref: "SwarmCommon.yaml#/components/responses/500"
   759          default:
   760            description: Default response
   761  
   762    "/pss/send/{topic}/{targets}":
   763      post:
   764        summary: Send to recipient or target with Postal Service for Swarm
   765        tags:
   766          - Postal Service for Swarm
   767        parameters:
   768          - in: path
   769            name: topic
   770            schema:
   771              $ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
   772            required: true
   773            description: Topic name
   774          - in: path
   775            name: targets
   776            schema:
   777              $ref: "SwarmCommon.yaml#/components/schemas/PssTargets"
   778            required: true
   779            description: Target message address prefix. If multiple targets are specified, only one would be matched.
   780          - in: query
   781            name: recipient
   782            schema:
   783              $ref: "SwarmCommon.yaml#/components/schemas/PssRecipient"
   784            required: false
   785            description: Recipient publickey
   786          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   787        responses:
   788          "201":
   789            description: Subscribed to topic
   790          "400":
   791            $ref: "SwarmCommon.yaml#/components/responses/400"
   792          "402":
   793            $ref: "SwarmCommon.yaml#/components/responses/402"
   794          "500":
   795            $ref: "SwarmCommon.yaml#/components/responses/500"
   796          default:
   797            description: Default response
   798  
   799    "/pss/subscribe/{topic}":
   800      get:
   801        summary: Subscribe for messages on the given topic.
   802        tags:
   803          - Postal Service for Swarm
   804        parameters:
   805          - in: path
   806            name: topic
   807            schema:
   808              $ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
   809            required: true
   810            description: Topic name
   811        responses:
   812          "200":
   813            description: Returns a WebSocket with a subscription for incoming message data on the requested topic.
   814          "500":
   815            $ref: "SwarmCommon.yaml#/components/responses/500"
   816          default:
   817            description: Default response
   818  
   819    "/soc/{owner}/{id}":
   820      post:
   821        summary: Upload single owner chunk
   822        tags:
   823          - Single owner chunk
   824        parameters:
   825          - in: path
   826            name: owner
   827            schema:
   828              $ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
   829            required: true
   830            description: Owner
   831          - in: path
   832            name: id
   833            schema:
   834              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
   835            required: true
   836            description: Id
   837          - in: query
   838            name: sig
   839            schema:
   840              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
   841            required: true
   842            description: Signature
   843          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
   844          - in: header
   845            name: swarm-postage-batch-id
   846            schema:
   847              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   848            required: false
   849          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageStamp"
   850          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmAct"
   851          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   852        requestBody:
   853          required: true
   854          description: The SOC binary data is composed of the span (8 bytes) and the at most 4KB payload.
   855          content:
   856            application/octet-stream:
   857              schema:
   858                type: string
   859                format: binary
   860        responses:
   861          "201":
   862            description: Created
   863            content:
   864              application/json:
   865                schema:
   866                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   867            headers:
   868              "swarm-act-history-address":
   869                $ref: "SwarmCommon.yaml#/components/headers/SwarmActHistoryAddress"
   870          "400":
   871            $ref: "SwarmCommon.yaml#/components/responses/400"
   872          "401":
   873            $ref: "SwarmCommon.yaml#/components/responses/401"
   874          "402":
   875            $ref: "SwarmCommon.yaml#/components/responses/402"
   876          "500":
   877            $ref: "SwarmCommon.yaml#/components/responses/500"
   878          default:
   879            description: Default response
   880  
   881    "/feeds/{owner}/{topic}":
   882      post:
   883        summary: Create an initial feed root manifest
   884        tags:
   885          - Feed
   886        parameters:
   887          - in: path
   888            name: owner
   889            schema:
   890              $ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
   891            required: true
   892            description: Owner
   893          - in: path
   894            name: topic
   895            schema:
   896              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
   897            required: true
   898            description: Topic
   899          - in: query
   900            name: type
   901            schema:
   902              $ref: "SwarmCommon.yaml#/components/schemas/FeedType"
   903            required: false
   904            description: "Feed indexing scheme (default: sequence)"
   905          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
   906          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
   907          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmAct"
   908          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
   909        responses:
   910          "201":
   911            description: Created
   912            content:
   913              application/json:
   914                schema:
   915                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   916            headers:
   917              "swarm-act-history-address":
   918                $ref: "SwarmCommon.yaml#/components/headers/SwarmActHistoryAddress"
   919          "400":
   920            $ref: "SwarmCommon.yaml#/components/responses/400"
   921          "401":
   922            $ref: "SwarmCommon.yaml#/components/responses/401"
   923          "402":
   924            $ref: "SwarmCommon.yaml#/components/responses/402"
   925          "500":
   926            $ref: "SwarmCommon.yaml#/components/responses/500"
   927          default:
   928            description: Default response
   929      get:
   930        summary: Find feed update
   931        tags:
   932          - Feed
   933        parameters:
   934          - in: path
   935            name: owner
   936            schema:
   937              $ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
   938            required: true
   939            description: Owner
   940          - in: path
   941            name: topic
   942            schema:
   943              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
   944            required: true
   945            description: Topic
   946          - in: query
   947            name: at
   948            schema:
   949              type: integer
   950            required: false
   951            description: "Timestamp of the update (default: now)"
   952          - in: query
   953            name: after
   954            schema:
   955              type: integer
   956            required: false
   957            description: "Start index (default: 0)"
   958          - in: query
   959            name: type
   960            schema:
   961              $ref: "SwarmCommon.yaml#/components/schemas/FeedType"
   962            required: false
   963            description: "Feed indexing scheme (default: sequence)"
   964        responses:
   965          "200":
   966            description: Latest feed update
   967            headers:
   968              "swarm-feed-index":
   969                $ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndex"
   970              "swarm-feed-index-next":
   971                $ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndexNext"
   972            content:
   973              application/json:
   974                schema:
   975                  $ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
   976          "400":
   977            $ref: "SwarmCommon.yaml#/components/responses/400"
   978          "401":
   979            $ref: "SwarmCommon.yaml#/components/responses/401"
   980          "500":
   981            $ref: "SwarmCommon.yaml#/components/responses/500"
   982          default:
   983            description: Default response
   984  
   985    "/stewardship/{reference}":
   986      get:
   987        summary: "Check if content is available"
   988        tags:
   989          - Stewardship
   990        parameters:
   991          - in: path
   992            name: reference
   993            schema:
   994              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
   995            required: true
   996            description: "Root hash of content (can be of any type: collection, file, chunk)"
   997        responses:
   998          "200":
   999            description: Returns if the content is retrievable
  1000            content:
  1001              application/json:
  1002                schema:
  1003                  $ref: "SwarmCommon.yaml#/components/schemas/IsRetrievableResponse"
  1004          "404":
  1005            $ref: "SwarmCommon.yaml#/components/responses/404"
  1006          "500":
  1007            $ref: "SwarmCommon.yaml#/components/responses/500"
  1008          default:
  1009            description: Default response
  1010      put:
  1011        summary: "Re-upload content for specified root hash"
  1012        tags:
  1013          - Stewardship
  1014        parameters:
  1015          - in: path
  1016            name: reference
  1017            schema:
  1018              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
  1019            required: true
  1020            description: "Re-uploads content for specified root hash (can be of any type: collection, file, chunk, etc.)"
  1021          - in: header
  1022            schema:
  1023              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
  1024            name: swarm-postage-batch-id
  1025            description: Postage batch to use for re-upload. If none is provided and the file was uploaded on the same node before, it will reuse the same batch. If not found, it will return error. If a new batch is provided, the chunks are stamped again with the new batch.
  1026        responses:
  1027          "200":
  1028            description: Ok
  1029          "400":
  1030            $ref: "SwarmCommon.yaml#/components/responses/400"
  1031          "404":
  1032            $ref: "SwarmCommon.yaml#/components/responses/404"
  1033          "500":
  1034            $ref: "SwarmCommon.yaml#/components/responses/500"
  1035          default:
  1036            description: Default response
  1037  
  1038    "/addresses":
  1039      get:
  1040        summary: Get overlay and underlay addresses of the node
  1041        tags:
  1042          - Connectivity
  1043        responses:
  1044          "200":
  1045            description: Own node underlay and overlay addresses
  1046            content:
  1047              application/json:
  1048                schema:
  1049                  $ref: "SwarmCommon.yaml#/components/schemas/Addresses"
  1050          "500":
  1051            $ref: "SwarmCommon.yaml#/components/responses/500"
  1052          default:
  1053            description: Default response
  1054  
  1055    "/health":
  1056      get:
  1057        summary: Get node overall health Status
  1058        description: |
  1059          Health Status will indicate node healthiness.
  1060  
  1061          If node is unhealthy please check node logs for errors.
  1062        tags:
  1063          - Status
  1064        responses:
  1065          "200":
  1066            description: Health Status of node
  1067            content:
  1068              application/json:
  1069                schema:
  1070                  $ref: "SwarmCommon.yaml#/components/schemas/HealthStatus"
  1071          default:
  1072            description: Default response
  1073  
  1074    "/readiness":
  1075      get:
  1076        summary: Readiness endpoint indicates if node is ready to start accepting traffic
  1077        tags:
  1078          - Status
  1079        responses:
  1080          "200":
  1081            description: Indicates that node is ready
  1082            $ref: "SwarmCommon.yaml#/components/responses/200"
  1083          "400":
  1084            description: Indicates that node is not ready
  1085            $ref: "SwarmCommon.yaml#/components/responses/400"
  1086          default:
  1087            description: Default response
  1088  
  1089    "/balances":
  1090      get:
  1091        summary: Get the balances with all known peers including prepaid services
  1092        security:
  1093          - bearerAuth: []
  1094        tags:
  1095          - Balance
  1096        responses:
  1097          "200":
  1098            description: Own balances with all known peers
  1099            content:
  1100              application/json:
  1101                schema:
  1102                  $ref: "SwarmCommon.yaml#/components/schemas/Balances"
  1103          "500":
  1104            $ref: "SwarmCommon.yaml#/components/responses/500"
  1105          default:
  1106            description: Default response
  1107  
  1108    "/balances/{address}":
  1109      get:
  1110        summary: Get the balances with a specific peer including prepaid services
  1111        security:
  1112          - bearerAuth: []
  1113        tags:
  1114          - Balance
  1115        parameters:
  1116          - in: path
  1117            name: address
  1118            schema:
  1119              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1120            required: true
  1121            description: Swarm address of peer
  1122        responses:
  1123          "200":
  1124            description: Balance with the specific peer
  1125            content:
  1126              application/json:
  1127                schema:
  1128                  $ref: "SwarmCommon.yaml#/components/schemas/Balance"
  1129          "400":
  1130            $ref: "SwarmCommon.yaml#/components/responses/400"
  1131          "500":
  1132            $ref: "SwarmCommon.yaml#/components/responses/500"
  1133          default:
  1134            description: Default response
  1135  
  1136    "/blocklist":
  1137      get:
  1138        summary: Get a list of blocklisted peers
  1139        security:
  1140          - bearerAuth: []
  1141        tags:
  1142          - Connectivity
  1143        responses:
  1144          "200":
  1145            description: Returns overlay addresses of blocklisted peers
  1146            content:
  1147              application/json:
  1148                schema:
  1149                  $ref: "SwarmCommon.yaml#/components/schemas/BlockListedPeers"
  1150          "500":
  1151            $ref: "SwarmCommon.yaml#/components/responses/500"
  1152          default:
  1153            description: Default response
  1154  
  1155    "/consumed":
  1156      get:
  1157        summary: Get the past due consumption balances with all known peers
  1158        security:
  1159          - bearerAuth: []
  1160        tags:
  1161          - Balance
  1162        responses:
  1163          "200":
  1164            description: Own past due consumption balances with all known peers
  1165            content:
  1166              application/json:
  1167                schema:
  1168                  $ref: "SwarmCommon.yaml#/components/schemas/Balances"
  1169          "500":
  1170            $ref: "SwarmCommon.yaml#/components/responses/500"
  1171          default:
  1172            description: Default response
  1173  
  1174    "/consumed/{address}":
  1175      get:
  1176        summary: Get the past due consumption balance with a specific peer
  1177        security:
  1178          - bearerAuth: []
  1179        tags:
  1180          - Balance
  1181        parameters:
  1182          - in: path
  1183            name: address
  1184            schema:
  1185              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1186            required: true
  1187            description: Swarm address of peer
  1188        responses:
  1189          "200":
  1190            description: Past-due consumption balance with the specific peer
  1191            content:
  1192              application/json:
  1193                schema:
  1194                  $ref: "SwarmCommon.yaml#/components/schemas/Balance"
  1195          "400":
  1196            $ref: "SwarmCommon.yaml#/components/responses/400"
  1197          "500":
  1198            $ref: "SwarmCommon.yaml#/components/responses/500"
  1199          default:
  1200            description: Default response
  1201  
  1202    "/chequebook/address":
  1203      get:
  1204        summary: Get the address of the chequebook contract used
  1205        security:
  1206          - bearerAuth: []
  1207        tags:
  1208          - Chequebook
  1209        responses:
  1210          "200":
  1211            description: Ethereum address of chequebook contract
  1212            content:
  1213              application/json:
  1214                schema:
  1215                  $ref: "SwarmCommon.yaml#/components/schemas/ChequebookAddress"
  1216  
  1217    "/chequebook/balance":
  1218      get:
  1219        summary: Get the balance of the chequebook
  1220        security:
  1221          - bearerAuth: []
  1222        tags:
  1223          - Chequebook
  1224        responses:
  1225          "200":
  1226            description: Balance of the chequebook
  1227            content:
  1228              application/json:
  1229                schema:
  1230                  $ref: "SwarmCommon.yaml#/components/schemas/ChequebookBalance"
  1231          "500":
  1232            $ref: "SwarmCommon.yaml#/components/responses/500"
  1233          default:
  1234            description: Default response
  1235  
  1236    "/chunks/{address}":
  1237      get:
  1238        summary: "Get chunk"
  1239        tags:
  1240          - Chunk
  1241        parameters:
  1242          - in: path
  1243            name: reference
  1244            schema:
  1245              $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
  1246            required: true
  1247            description: Swarm address of chunk
  1248          - in: header
  1249            schema:
  1250              $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
  1251            name: swarm-cache
  1252            required: false
  1253          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
  1254          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
  1255          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
  1256        responses:
  1257          "200":
  1258            description: Retrieved chunk content
  1259            content:
  1260              application/octet-stream:
  1261                schema:
  1262                  type: string
  1263                  format: binary
  1264          "400":
  1265            $ref: "SwarmCommon.yaml#/components/responses/400"
  1266          "404":
  1267            $ref: "SwarmCommon.yaml#/components/responses/404"
  1268          "500":
  1269            $ref: "SwarmCommon.yaml#/components/responses/500"
  1270          default:
  1271            description: Default response
  1272      head:
  1273        summary: Check if chunk at address exists locally
  1274        tags:
  1275          - Chunk
  1276        parameters:
  1277          - in: path
  1278            name: address
  1279            schema:
  1280              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1281            required: true
  1282            description: Swarm address of chunk
  1283          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
  1284          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
  1285          - $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
  1286        responses:
  1287          "200":
  1288            description: Chunk exists
  1289          "400":
  1290            $ref: "SwarmCommon.yaml#/components/responses/400"
  1291          "404":
  1292            $ref: "SwarmCommon.yaml#/components/responses/404"
  1293          default:
  1294            description: Default response
  1295  
  1296    "/envelope/{address}":
  1297      post:
  1298        summary: "Create postage stamp signature against given chunk address"
  1299        tags:
  1300          - Envelope
  1301        parameters:
  1302          - in: header
  1303            name: swarm-postage-batch-id
  1304            schema:
  1305              $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
  1306            required: true
  1307        responses:
  1308          "201":
  1309            description: Ok
  1310            content:
  1311              application/json:
  1312                schema:
  1313                  $ref: "SwarmCommon.yaml#/components/schemas/PostEnvelopeResponse"
  1314          "400":
  1315            $ref: "SwarmCommon.yaml#/components/responses/400"
  1316          "402":
  1317            $ref: "SwarmCommon.yaml#/components/responses/402"
  1318          "500":
  1319            $ref: "SwarmCommon.yaml#/components/responses/500"
  1320          default:
  1321            description: Default response
  1322  
  1323    "/connect/{multiAddress}":
  1324      post:
  1325        summary: Connect to address
  1326        security:
  1327          - bearerAuth: []
  1328        tags:
  1329          - Connectivity
  1330        parameters:
  1331          - in: path
  1332            allowReserved: true
  1333            name: multiAddress
  1334            schema:
  1335              $ref: "SwarmCommon.yaml#/components/schemas/MultiAddress"
  1336            required: true
  1337            description: Underlay address of peer
  1338        responses:
  1339          "200":
  1340            description: Returns overlay address of connected peer
  1341            content:
  1342              application/json:
  1343                schema:
  1344                  $ref: "SwarmCommon.yaml#/components/schemas/Address"
  1345          "400":
  1346            $ref: "SwarmCommon.yaml#/components/responses/400"
  1347          "500":
  1348            $ref: "SwarmCommon.yaml#/components/responses/500"
  1349          default:
  1350            description: Default response
  1351  
  1352    "/reservestate":
  1353      get:
  1354        summary: Get reserve state
  1355        security:
  1356          - bearerAuth: []
  1357        tags:
  1358          - Status
  1359        responses:
  1360          "200":
  1361            description: Reserve State
  1362            content:
  1363              application/json:
  1364                schema:
  1365                  $ref: "SwarmCommon.yaml#/components/schemas/ReserveState"
  1366          default:
  1367            description: Default response
  1368  
  1369    "/chainstate":
  1370      get:
  1371        summary: Get chain state
  1372        security:
  1373          - bearerAuth: []
  1374        tags:
  1375          - Status
  1376        responses:
  1377          "200":
  1378            description: Chain State
  1379            content:
  1380              application/json:
  1381                schema:
  1382                  $ref: "SwarmCommon.yaml#/components/schemas/ChainState"
  1383          default:
  1384            description: Default response
  1385  
  1386    "/node":
  1387      get:
  1388        summary: Get information about the node
  1389        tags:
  1390          - Status
  1391        responses:
  1392          "200":
  1393            description: Information about the node
  1394            content:
  1395              application/json:
  1396                schema:
  1397                  $ref: "SwarmCommon.yaml#/components/schemas/Node"
  1398          default:
  1399            description: Default response
  1400  
  1401    "/peers":
  1402      get:
  1403        summary: Get a list of peers
  1404        security:
  1405          - bearerAuth: []
  1406        tags:
  1407          - Connectivity
  1408        responses:
  1409          "200":
  1410            description: Returns overlay addresses of connected peers
  1411            content:
  1412              application/json:
  1413                schema:
  1414                  $ref: "SwarmCommon.yaml#/components/schemas/Peers"
  1415          default:
  1416            description: Default response
  1417  
  1418    "/peers/{address}":
  1419      delete:
  1420        summary: Remove peer
  1421        security:
  1422          - bearerAuth: []
  1423        tags:
  1424          - Connectivity
  1425        parameters:
  1426          - in: path
  1427            name: address
  1428            schema:
  1429              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1430            required: true
  1431            description: Swarm address of peer
  1432        responses:
  1433          "200":
  1434            description: Disconnected peer
  1435            content:
  1436              application/json:
  1437                schema:
  1438                  $ref: "SwarmCommon.yaml#/components/schemas/Response"
  1439          "400":
  1440            $ref: "SwarmCommon.yaml#/components/responses/400"
  1441          "500":
  1442            $ref: "SwarmCommon.yaml#/components/responses/500"
  1443          default:
  1444            description: Default response
  1445  
  1446    "/pingpong/{address}":
  1447      post:
  1448        summary: Try connection to node
  1449        security:
  1450          - bearerAuth: []
  1451        tags:
  1452          - Connectivity
  1453        parameters:
  1454          - in: path
  1455            name: address
  1456            schema:
  1457              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1458            required: true
  1459            description: Swarm address of peer
  1460        responses:
  1461          "200":
  1462            description: Returns round trip time for given peer
  1463            content:
  1464              application/json:
  1465                schema:
  1466                  $ref: "SwarmCommon.yaml#/components/schemas/RttMs"
  1467          "400":
  1468            $ref: "SwarmCommon.yaml#/components/responses/400"
  1469          "404":
  1470            $ref: "SwarmCommon.yaml#/components/responses/404"
  1471          "500":
  1472            $ref: "SwarmCommon.yaml#/components/responses/500"
  1473          default:
  1474            description: Default response
  1475  
  1476    "/settlements/{address}":
  1477      get:
  1478        summary: Get amount of sent and received from settlements with a peer
  1479        security:
  1480          - bearerAuth: []
  1481        tags:
  1482          - Settlements
  1483        parameters:
  1484          - in: path
  1485            name: address
  1486            schema:
  1487              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1488            required: true
  1489            description: Swarm address of peer
  1490        responses:
  1491          "200":
  1492            description: Amount of sent or received from settlements with a peer
  1493            content:
  1494              application/json:
  1495                schema:
  1496                  $ref: "SwarmCommon.yaml#/components/schemas/Settlement"
  1497          "400":
  1498            $ref: "SwarmCommon.yaml#/components/responses/400"
  1499          "500":
  1500            $ref: "SwarmCommon.yaml#/components/responses/500"
  1501          default:
  1502            description: Default response
  1503  
  1504    "/settlements":
  1505      get:
  1506        summary: Get settlements with all known peers and total amount sent or received
  1507        security:
  1508          - bearerAuth: []
  1509        tags:
  1510          - Settlements
  1511        responses:
  1512          "200":
  1513            description: Settlements with all known peers and total amount sent or received
  1514            content:
  1515              application/json:
  1516                schema:
  1517                  $ref: "SwarmCommon.yaml#/components/schemas/Settlements"
  1518          "500":
  1519            $ref: "SwarmCommon.yaml#/components/responses/500"
  1520          default:
  1521            description: Default response
  1522  
  1523    "/timesettlements":
  1524      get:
  1525        summary: Get time based settlements with all known peers and total amount sent or received
  1526        security:
  1527          - bearerAuth: []
  1528        tags:
  1529          - Settlements
  1530        responses:
  1531          "200":
  1532            description: Time based settlements with all known peers and total amount sent or received
  1533            content:
  1534              application/json:
  1535                schema:
  1536                  $ref: "SwarmCommon.yaml#/components/schemas/Settlements"
  1537          "500":
  1538            $ref: "SwarmCommon.yaml#/components/responses/500"
  1539          default:
  1540            description: Default response
  1541  
  1542    "/topology":
  1543      get:
  1544        summary: Get topology of known network
  1545        security:
  1546          - bearerAuth: []
  1547        tags:
  1548          - Connectivity
  1549        responses:
  1550          "200":
  1551            description: Swarm topology of the bee node
  1552            content:
  1553              application/json:
  1554                schema:
  1555                  $ref: "SwarmCommon.yaml#/components/schemas/BzzTopology"
  1556  
  1557    "/welcome-message":
  1558      get:
  1559        summary: Get configured P2P welcome message
  1560        security:
  1561          - bearerAuth: []
  1562        tags:
  1563          - Connectivity
  1564        responses:
  1565          "200":
  1566            description: Welcome message
  1567            content:
  1568              application/json:
  1569                schema:
  1570                  $ref: "SwarmCommon.yaml#/components/schemas/WelcomeMessage"
  1571          "500":
  1572            $ref: "SwarmCommon.yaml#/components/responses/500"
  1573          default:
  1574            description: Default response
  1575      post:
  1576        summary: Set P2P welcome message
  1577        security:
  1578          - bearerAuth: []
  1579        tags:
  1580          - Connectivity
  1581        requestBody:
  1582          content:
  1583            application/json:
  1584              schema:
  1585                $ref: "SwarmCommon.yaml#/components/schemas/WelcomeMessage"
  1586        responses:
  1587          "200":
  1588            description: OK
  1589            content:
  1590              application/json:
  1591                schema:
  1592                  $ref: "SwarmCommon.yaml#/components/schemas/HealthStatus"
  1593          "400":
  1594            $ref: "SwarmCommon.yaml#/components/responses/400"
  1595          "500":
  1596            $ref: "SwarmCommon.yaml#/components/responses/500"
  1597          default:
  1598            description: Default response
  1599  
  1600    "/chequebook/cashout/{peer-id}":
  1601      get:
  1602        summary: Get last cashout action for the peer
  1603        security:
  1604          - bearerAuth: []
  1605        parameters:
  1606          - in: path
  1607            name: peer-id
  1608            schema:
  1609              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1610            required: true
  1611            description: Swarm address of peer
  1612        tags:
  1613          - Chequebook
  1614        responses:
  1615          "200":
  1616            description: Cashout status
  1617            content:
  1618              application/json:
  1619                schema:
  1620                  $ref: "SwarmCommon.yaml#/components/schemas/SwapCashoutStatus"
  1621          "404":
  1622            $ref: "SwarmCommon.yaml#/components/responses/404"
  1623          "500":
  1624            $ref: "SwarmCommon.yaml#/components/responses/500"
  1625          default:
  1626            description: Default response
  1627      post:
  1628        summary: Cashout the last cheque for the peer
  1629        security:
  1630          - bearerAuth: []
  1631        parameters:
  1632          - in: path
  1633            name: peer-id
  1634            schema:
  1635              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1636            required: true
  1637            description: Swarm address of peer
  1638          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  1639          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  1640        tags:
  1641          - Chequebook
  1642        responses:
  1643          "201":
  1644            description: OK
  1645            content:
  1646              application/json:
  1647                schema:
  1648                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
  1649          "404":
  1650            $ref: "SwarmCommon.yaml#/components/responses/404"
  1651          "429":
  1652            $ref: "SwarmCommon.yaml#/components/responses/429"
  1653          "500":
  1654            $ref: "SwarmCommon.yaml#/components/responses/500"
  1655          default:
  1656            description: Default response
  1657  
  1658    "/chequebook/cheque/{peer-id}":
  1659      get:
  1660        summary: Get last cheques for the peer
  1661        security:
  1662          - bearerAuth: []
  1663        parameters:
  1664          - in: path
  1665            name: peer-id
  1666            schema:
  1667              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  1668            required: true
  1669            description: Swarm address of peer
  1670        tags:
  1671          - Chequebook
  1672        responses:
  1673          "200":
  1674            description: Last cheques
  1675            content:
  1676              application/json:
  1677                schema:
  1678                  $ref: "SwarmCommon.yaml#/components/schemas/ChequePeerResponse"
  1679          "404":
  1680            $ref: "SwarmCommon.yaml#/components/responses/404"
  1681          "500":
  1682            $ref: "SwarmCommon.yaml#/components/responses/500"
  1683          default:
  1684            description: Default response
  1685  
  1686    "/chequebook/cheque":
  1687      get:
  1688        summary: Get last cheques for all peers
  1689        security:
  1690          - bearerAuth: []
  1691        tags:
  1692          - Chequebook
  1693        responses:
  1694          "200":
  1695            description: Last cheques
  1696            content:
  1697              application/json:
  1698                schema:
  1699                  $ref: "SwarmCommon.yaml#/components/schemas/ChequeAllPeersResponse"
  1700          "404":
  1701            $ref: "SwarmCommon.yaml#/components/responses/404"
  1702          "500":
  1703            $ref: "SwarmCommon.yaml#/components/responses/500"
  1704          default:
  1705            description: Default response
  1706  
  1707    "/chequebook/deposit":
  1708      post:
  1709        summary: Deposit tokens from overlay address into chequebook
  1710        security:
  1711          - bearerAuth: []
  1712        parameters:
  1713          - in: query
  1714            name: amount
  1715            schema:
  1716              type: integer
  1717            required: true
  1718            description: amount of tokens to deposit
  1719          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  1720        tags:
  1721          - Chequebook
  1722        responses:
  1723          "201":
  1724            description: Transaction hash of the deposit transaction
  1725            content:
  1726              application/json:
  1727                schema:
  1728                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
  1729          "400":
  1730            $ref: "SwarmCommon.yaml#/components/responses/404"
  1731          "500":
  1732            $ref: "SwarmCommon.yaml#/components/responses/500"
  1733          default:
  1734            description: Default response
  1735  
  1736    "/chequebook/withdraw":
  1737      post:
  1738        summary: Withdraw tokens from the chequebook to the overlay address
  1739        security:
  1740          - bearerAuth: []
  1741        parameters:
  1742          - in: query
  1743            name: amount
  1744            schema:
  1745              type: integer
  1746            required: true
  1747            description: amount of tokens to withdraw
  1748          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  1749        tags:
  1750          - Chequebook
  1751        responses:
  1752          "201":
  1753            description: Transaction hash of the withdraw transaction
  1754            content:
  1755              application/json:
  1756                schema:
  1757                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
  1758          "400":
  1759            $ref: "SwarmCommon.yaml#/components/responses/404"
  1760          "500":
  1761            $ref: "SwarmCommon.yaml#/components/responses/500"
  1762          default:
  1763            description: Default response
  1764  
  1765    "/transactions":
  1766      get:
  1767        summary: Get list of pending transactions
  1768        tags:
  1769          - Transaction
  1770        responses:
  1771          "200":
  1772            description: List of pending transactions
  1773            content:
  1774              application/json:
  1775                schema:
  1776                  $ref: "SwarmCommon.yaml#/components/schemas/PendingTransactionsResponse"
  1777          "500":
  1778            $ref: "SwarmCommon.yaml#/components/responses/500"
  1779          default:
  1780            description: Default response
  1781  
  1782    "/transactions/{txHash}":
  1783      get:
  1784        summary: Get information about a sent transaction
  1785        parameters:
  1786          - in: path
  1787            name: txHash
  1788            schema:
  1789              $ref: "SwarmCommon.yaml#/components/schemas/TransactionHash"
  1790            required: true
  1791            description: Hash of the transaction
  1792        tags:
  1793          - Transaction
  1794        responses:
  1795          "200":
  1796            description: Get info about transaction
  1797            content:
  1798              application/json:
  1799                schema:
  1800                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionInfo"
  1801          "404":
  1802            $ref: "SwarmCommon.yaml#/components/responses/404"
  1803          "500":
  1804            $ref: "SwarmCommon.yaml#/components/responses/500"
  1805          default:
  1806            description: Default response
  1807      post:
  1808        summary: Rebroadcast existing transaction
  1809        parameters:
  1810          - in: path
  1811            name: txHash
  1812            schema:
  1813              $ref: "SwarmCommon.yaml#/components/schemas/TransactionHash"
  1814            required: true
  1815            description: Hash of the transaction
  1816        tags:
  1817          - Transaction
  1818        responses:
  1819          "200":
  1820            description: Hash of the transaction
  1821            content:
  1822              application/json:
  1823                schema:
  1824                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
  1825          "404":
  1826            $ref: "SwarmCommon.yaml#/components/responses/404"
  1827          "500":
  1828            $ref: "SwarmCommon.yaml#/components/responses/500"
  1829          default:
  1830            description: Default response
  1831      delete:
  1832        summary: Cancel existing transaction
  1833        parameters:
  1834          - in: path
  1835            name: txHash
  1836            schema:
  1837              $ref: "SwarmCommon.yaml#/components/schemas/TransactionHash"
  1838            required: true
  1839            description: Hash of the transaction
  1840          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  1841        tags:
  1842          - Transaction
  1843        responses:
  1844          "200":
  1845            description: Hash of the transaction
  1846            content:
  1847              application/json:
  1848                schema:
  1849                  $ref: "SwarmCommon.yaml#/components/schemas/TransactionResponse"
  1850          "404":
  1851            $ref: "SwarmCommon.yaml#/components/responses/404"
  1852          "500":
  1853            $ref: "SwarmCommon.yaml#/components/responses/500"
  1854          default:
  1855            description: Default response
  1856  
  1857    "/stamps":
  1858      get:
  1859        summary: Get stamps for this node
  1860        security:
  1861          - bearerAuth: []
  1862        tags:
  1863          - Postage Stamps
  1864        responses:
  1865          "200":
  1866            description: Returns an array of postage batches.
  1867            content:
  1868              application/json:
  1869                schema:
  1870                  $ref: "SwarmCommon.yaml#/components/schemas/DebugPostageBatchesResponse"
  1871          "404":
  1872            $ref: "SwarmCommon.yaml#/components/responses/404"
  1873  
  1874          default:
  1875            description: Default response
  1876  
  1877    "/stamps/{batch_id}":
  1878      parameters:
  1879        - in: path
  1880          name: batch_id
  1881          schema:
  1882            $ref: "SwarmCommon.yaml#/components/schemas/BatchID"
  1883          required: true
  1884          description: Swarm address of the stamp
  1885      get:
  1886        summary: Get an individual postage batch status
  1887        security:
  1888          - bearerAuth: []
  1889        tags:
  1890          - Postage Stamps
  1891        responses:
  1892          "200":
  1893            description: Returns an individual postage batch state
  1894            content:
  1895              application/json:
  1896                schema:
  1897                  $ref: "SwarmCommon.yaml#/components/schemas/DebugPostageBatch"
  1898          "404":
  1899            $ref: "SwarmCommon.yaml#/components/responses/404"
  1900          "400":
  1901            $ref: "SwarmCommon.yaml#/components/responses/400"
  1902          default:
  1903            description: Default response
  1904  
  1905    "/stamps/{batch_id}/buckets":
  1906      parameters:
  1907        - in: path
  1908          name: batch_id
  1909          schema:
  1910            $ref: "SwarmCommon.yaml#/components/schemas/BatchID"
  1911          required: true
  1912          description: Swarm address of the stamp
  1913      get:
  1914        summary: Get extended bucket data of a batch
  1915        security:
  1916          - bearerAuth: []
  1917        tags:
  1918          - Postage Stamps
  1919        responses:
  1920          "200":
  1921            description: Returns extended bucket data of the provided batch ID
  1922            content:
  1923              application/json:
  1924                schema:
  1925                  $ref: "SwarmCommon.yaml#/components/schemas/PostageStampBuckets"
  1926          "404":
  1927            $ref: "SwarmCommon.yaml#/components/responses/404"
  1928          "400":
  1929            $ref: "SwarmCommon.yaml#/components/responses/400"
  1930          default:
  1931            description: Default response
  1932  
  1933    "/stamps/{amount}/{depth}":
  1934      post:
  1935        summary: Buy a new postage batch.
  1936        security:
  1937          - bearerAuth: []
  1938        description: |
  1939          Be aware, this endpoint creates an on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!
  1940        tags:
  1941          - Postage Stamps
  1942        parameters:
  1943          - in: path
  1944            name: amount
  1945            schema:
  1946              $ref: "SwarmCommon.yaml#/components/schemas/BigInt"
  1947            required: true
  1948            description: Amount of BZZ added that the postage batch will have.
  1949          - in: path
  1950            name: depth
  1951            schema:
  1952              type: integer
  1953            required: true
  1954            description: Batch depth which specifies how many chunks can be signed with the batch. It is a logarithm. Must be higher than default bucket depth (16)
  1955          - in: query
  1956            name: label
  1957            schema:
  1958              type: string
  1959            required: false
  1960            description: An optional label for this batch
  1961          - in: header
  1962            name: immutable
  1963            schema:
  1964              type: boolean
  1965            required: false
  1966          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  1967          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  1968        responses:
  1969          "201":
  1970            description: Returns the newly created postage batch ID
  1971            content:
  1972              application/json:
  1973                schema:
  1974                  $ref: "SwarmCommon.yaml#/components/schemas/BatchIDResponse"
  1975          "400":
  1976            $ref: "SwarmCommon.yaml#/components/responses/400"
  1977          "429":
  1978            $ref: "SwarmCommon.yaml#/components/responses/429"
  1979          "500":
  1980            $ref: "SwarmCommon.yaml#/components/responses/500"
  1981          default:
  1982            description: Default response
  1983  
  1984    "/stamps/topup/{batch_id}/{amount}":
  1985      patch:
  1986        summary: Top up an existing postage batch.
  1987        description: |
  1988          Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!
  1989        tags:
  1990          - Postage Stamps
  1991        parameters:
  1992          - in: path
  1993            name: batch_id
  1994            schema:
  1995              $ref: "SwarmCommon.yaml#/components/schemas/BatchID"
  1996            required: true
  1997            description: Batch ID to top up
  1998          - in: path
  1999            name: amount
  2000            schema:
  2001              type: integer
  2002            required: true
  2003            description: Amount of BZZ per chunk to top up to an existing postage batch.
  2004          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  2005          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  2006        responses:
  2007          "202":
  2008            description: Returns the postage batch ID that was topped up
  2009            content:
  2010              application/json:
  2011                schema:
  2012                  $ref: "SwarmCommon.yaml#/components/schemas/BatchIDResponse"
  2013          "400":
  2014            $ref: "SwarmCommon.yaml#/components/responses/400"
  2015          "429":
  2016            $ref: "SwarmCommon.yaml#/components/responses/429"
  2017          "402":
  2018            $ref: "SwarmCommon.yaml#/components/responses/402"
  2019          "500":
  2020            $ref: "SwarmCommon.yaml#/components/responses/500"
  2021          default:
  2022            description: Default response
  2023  
  2024    "/stamps/dilute/{batch_id}/{depth}":
  2025      patch:
  2026        summary: Dilute an existing postage batch.
  2027        description: |
  2028          Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!
  2029        tags:
  2030          - Postage Stamps
  2031        parameters:
  2032          - in: path
  2033            name: batch_id
  2034            schema:
  2035              $ref: "SwarmCommon.yaml#/components/schemas/BatchID"
  2036            required: true
  2037            description: Batch ID to dilute
  2038          - in: path
  2039            name: depth
  2040            schema:
  2041              type: integer
  2042            required: true
  2043            description: New batch depth. Must be higher than the previous depth.
  2044          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  2045          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  2046        responses:
  2047          "202":
  2048            description: Returns the postage batch ID that was diluted.
  2049            content:
  2050              application/json:
  2051                schema:
  2052                  $ref: "SwarmCommon.yaml#/components/schemas/BatchIDResponse"
  2053          "400":
  2054            $ref: "SwarmCommon.yaml#/components/responses/400"
  2055          "429":
  2056            $ref: "SwarmCommon.yaml#/components/responses/429"
  2057          "500":
  2058            $ref: "SwarmCommon.yaml#/components/responses/500"
  2059          default:
  2060            description: Default response
  2061  
  2062    "/batches":
  2063      get:
  2064        summary: Get all globally available batches that were purchased by all nodes.
  2065        security:
  2066          - bearerAuth: []
  2067        tags:
  2068          - Postage Stamps
  2069        responses:
  2070          "200":
  2071            description: Returns an array of all available and currently valid postage batches.
  2072            content:
  2073              application/json:
  2074                schema:
  2075                  $ref: "SwarmCommon.yaml#/components/schemas/DebugPostageAllBatchesResponse"
  2076  
  2077          default:
  2078            description: Default response
  2079  
  2080    "/rchash/{depth}/{anchor1}/{anchor2}":
  2081      get:
  2082        summary: Get reserve commitment hash with sample proofs
  2083        tags:
  2084          - RChash
  2085        parameters:
  2086          - in: path
  2087            name: depth
  2088            schema:
  2089              type: integer
  2090              minimum: 0
  2091              default: 0
  2092            required: true
  2093            description: The storage depth.
  2094          - in: path
  2095            name: anchor1
  2096            schema:
  2097              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
  2098            required: true
  2099            description: The first anchor.
  2100          - in: path
  2101            name: anchor2
  2102            schema:
  2103              $ref: "SwarmCommon.yaml#/components/schemas/HexString"
  2104            required: true
  2105            description: The second anchor.
  2106        responses:
  2107          "200":
  2108            description: Reserve sample response
  2109            content:
  2110              application/json:
  2111                schema:
  2112                  $ref: "SwarmCommon.yaml#/components/schemas/ApiRCHashResponse"
  2113          "500":
  2114            $ref: "SwarmCommon.yaml#/components/responses/500"
  2115          default:
  2116            description: Default response
  2117  
  2118    "/accounting":
  2119      get:
  2120        summary: Get all accounting associated values with all known peers
  2121        tags:
  2122          - Balance
  2123        responses:
  2124          "200":
  2125            description: Own accounting associated values with all known peers
  2126            content:
  2127              application/json:
  2128                schema:
  2129                  $ref: "SwarmCommon.yaml#/components/schemas/PeerAccountingData"
  2130          "500":
  2131            $ref: "SwarmCommon.yaml#/components/responses/500"
  2132          default:
  2133            description: Default response
  2134  
  2135    "/redistributionstate":
  2136      get:
  2137        summary: Get current status of node in redistribution game
  2138        tags:
  2139          - RedistributionState
  2140        responses:
  2141          "200":
  2142            description: Redistribution status info
  2143            content:
  2144              application/json:
  2145                schema:
  2146                  $ref: "SwarmCommon.yaml#/components/schemas/RedistributionStatusResponse"
  2147          "400":
  2148            $ref: "SwarmCommon.yaml#/components/responses/400"
  2149          "500":
  2150            $ref: "SwarmCommon.yaml#/components/responses/500"
  2151          default:
  2152            description: Default response
  2153    "/wallet":
  2154      get:
  2155        summary: Get wallet balance for BZZ and xDai
  2156        tags:
  2157          - Wallet
  2158        responses:
  2159          "200":
  2160            description: Wallet balance info
  2161            content:
  2162              application/json:
  2163                schema:
  2164                  $ref: "SwarmCommon.yaml#/components/schemas/WalletResponse"
  2165          "500":
  2166            $ref: "SwarmCommon.yaml#/components/responses/500"
  2167          default:
  2168            description: Default response
  2169    "/wallet/withdraw/{coin}":
  2170      post:
  2171        summary: Allows withdrawals of BZZ or xDAI to provided (whitelisted) address
  2172        tags:
  2173          - Wallet
  2174        parameters:
  2175          - in: query
  2176            name: amount
  2177            required: true
  2178            schema:
  2179              $ref: "SwarmCommon.yaml#/components/schemas/BigInt"
  2180          - in: query
  2181            name: address
  2182            required: true
  2183            schema:
  2184              $ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
  2185          - in: path
  2186            name: coin
  2187            required: true
  2188            schema:
  2189              $ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
  2190        responses:
  2191          "200":
  2192            content:
  2193              application/json:
  2194                schema:
  2195                  $ref: "SwarmCommon.yaml#/components/schemas/WalletTxResponse"
  2196            description: OK
  2197          "400":
  2198            $ref: "SwarmCommon.yaml#/components/responses/400"
  2199            description: Amount greater than balance or coin is other than BZZ/xDAI
  2200          "500":
  2201            $ref: "SwarmCommon.yaml#/components/responses/500"
  2202          default:
  2203            description: Default response
  2204  
  2205    "/stake/migrate":
  2206      post:
  2207        summary: Withdraws all past staked amount back to the wallet.
  2208        description: Be aware, the endpoint call only be called when the contract is paused and is in the process of being migrated to a new contract.
  2209        tags:
  2210          - Staking
  2211        responses:
  2212          "200":
  2213            $ref: "SwarmCommon.yaml#/components/schemas/StakeTransactionResponse"
  2214          "500":
  2215            $ref: "SwarmCommon.yaml#/components/responses/500"
  2216          default:
  2217            description: Default response
  2218  
  2219    "/stake/withdrawable":
  2220      get:
  2221        summary: Get the withdrawable staked amount.
  2222        description: This endpoint fetches any amount that is possible to withdraw as surplus.
  2223        tags:
  2224          - Staking
  2225        responses:
  2226          "200":
  2227            $ref: "SwarmCommon.yaml#/components/schemas/GetWithdrawableResponse"
  2228          "500":
  2229            $ref: "SwarmCommon.yaml#/components/responses/500"
  2230          default:
  2231            description: Default response
  2232      delete:
  2233        summary: Withdraw the extra withdrawable staked amount.
  2234        description: This endpoint withdraws any amount that is possible to withdraw as surplus.
  2235        tags:
  2236          - Staking
  2237        parameters:
  2238          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  2239          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  2240        responses:
  2241          "200":
  2242            $ref: "SwarmCommon.yaml#/components/schemas/StakeTransactionResponse"
  2243          "400":
  2244            $ref: "SwarmCommon.yaml#/components/responses/400"
  2245          "500":
  2246            $ref: "SwarmCommon.yaml#/components/responses/500"
  2247          default:
  2248            description: Default response
  2249  
  2250    "/stake/{amount}":
  2251      post:
  2252        summary: Deposit some amount for staking.
  2253        description: Be aware, this endpoint creates an on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance.
  2254        tags:
  2255          - Staking
  2256        parameters:
  2257          - in: path
  2258            name: amount
  2259            schema:
  2260              type: string
  2261            required: true
  2262            description: Amount of BZZ added that will be deposited for staking.
  2263          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  2264          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  2265        responses:
  2266          "200":
  2267            $ref: "SwarmCommon.yaml#/components/schemas/StakeTransactionResponse"
  2268          "400":
  2269            $ref: "SwarmCommon.yaml#/components/responses/400"
  2270          "500":
  2271            $ref: "SwarmCommon.yaml#/components/responses/500"
  2272          default:
  2273            description: Default response
  2274  
  2275    "/stake":
  2276      get:
  2277        summary: Get the staked amount.
  2278        description: This endpoint fetches the total staked amount from the blockchain.
  2279        tags:
  2280          - Staking
  2281        responses:
  2282          "200":
  2283            $ref: "SwarmCommon.yaml#/components/schemas/GetStakeResponse"
  2284          "500":
  2285            $ref: "SwarmCommon.yaml#/components/responses/500"
  2286          default:
  2287            description: Default response
  2288      delete:
  2289        summary: Withdraws all past staked amount back to the wallet.
  2290        description: Be aware, this endpoint can only be called when the contract is paused and is in the process of being migrated to a new contract.
  2291        tags:
  2292          - Staking
  2293        parameters:
  2294          - $ref: "SwarmCommon.yaml#/components/parameters/GasPriceParameter"
  2295          - $ref: "SwarmCommon.yaml#/components/parameters/GasLimitParameter"
  2296        responses:
  2297          "200":
  2298            $ref: "SwarmCommon.yaml#/components/schemas/StakeTransactionResponse"
  2299          "400":
  2300            $ref: "SwarmCommon.yaml#/components/responses/400"
  2301          "500":
  2302            $ref: "SwarmCommon.yaml#/components/responses/500"
  2303          default:
  2304            description: Default response
  2305  
  2306    "/loggers":
  2307      get:
  2308        summary: Get all available loggers.
  2309        tags:
  2310          - Logging
  2311        responses:
  2312          "200":
  2313            description: Returns an array of all available loggers, also represented in short form in a tree.
  2314            content:
  2315              application/json:
  2316                schema:
  2317                  $ref: "SwarmCommon.yaml#/components/schemas/LoggerResponse"
  2318          "400":
  2319            $ref: "SwarmCommon.yaml#/components/responses/400"
  2320          default:
  2321            description: Default response
  2322  
  2323    "/loggers/{exp}":
  2324      get:
  2325        summary: Get all available loggers that match the specified expression.
  2326        parameters:
  2327          - in: path
  2328            name: exp
  2329            schema:
  2330              $ref: "SwarmCommon.yaml#/components/schemas/LoggerExp"
  2331            required: true
  2332            description: Regular expression or a subsystem that matches the logger(s).
  2333        tags:
  2334          - Logging
  2335        responses:
  2336          "200":
  2337            description: Returns an array of all available loggers that matches given expression, also represented in short form in a tree.
  2338            content:
  2339              application/json:
  2340                schema:
  2341                  $ref: "SwarmCommon.yaml#/components/schemas/LoggerResponse"
  2342          "400":
  2343            $ref: "SwarmCommon.yaml#/components/responses/400"
  2344          default:
  2345            description: Default response
  2346      put:
  2347        summary: Set logger(s) verbosity level.
  2348        parameters:
  2349          - in: path
  2350            name: exp
  2351            schema:
  2352              $ref: "SwarmCommon.yaml#/components/schemas/LoggerExp"
  2353            required: true
  2354            description: Regular expression or a subsystem that matches the logger(s).
  2355        tags:
  2356          - Logging
  2357        responses:
  2358          "200":
  2359            description: The verbosity was changed successfully.
  2360          "400":
  2361            $ref: "SwarmCommon.yaml#/components/responses/400"
  2362          default:
  2363            description: Default response
  2364  
  2365    "/status":
  2366      get:
  2367        summary: Get the current status snapshot of this node.
  2368        tags:
  2369          - Node Status
  2370        responses:
  2371          "200":
  2372            description: Returns the current node status snapshot.
  2373            content:
  2374              application/json:
  2375                schema:
  2376                  $ref: "SwarmCommon.yaml#/components/schemas/StatusSnapshotResponse"
  2377          "400":
  2378            $ref: "SwarmCommon.yaml#/components/responses/400"
  2379          default:
  2380            description: Default response.
  2381  
  2382    "/status/peers":
  2383      get:
  2384        summary: Get the current status snapshot of this node connected peers.
  2385        tags:
  2386          - Node Status
  2387        responses:
  2388          "200":
  2389            description: Returns the status snapshot of this node connected peers
  2390            content:
  2391              application/json:
  2392                schema:
  2393                  $ref: "SwarmCommon.yaml#/components/schemas/StatusResponse"
  2394          "400":
  2395            $ref: "SwarmCommon.yaml#/components/responses/400"
  2396          default:
  2397            description: Default response.
  2398  
  2399  components:
  2400    securitySchemes:
  2401      basicAuth:
  2402        type: http
  2403        scheme: basic
  2404  
  2405      bearerAuth:
  2406        type: http
  2407        scheme: bearer
  2408        bearerFormat: SecurityToken