Merge pull request #30 from Etherna/improve/BNET-78-bee-1.18.2-support

Improve/bnet 78 bee 1.18.2 support
Etherna · Mar 17, 2024 · 63086af · 63086af
2 parents 71082fa + 74ebd79
commit 63086af
Show file tree

Hide file tree

Showing 9 changed files with 1,781 additions and 3,340 deletions.
diff --git a/src/BeeNet/Clients/DebugApi/v5_0_0/BeeDebugClient_5_0_0.cs b/src/BeeNet/Clients/DebugApi/v5_0_0/BeeDebugClient_5_0_0.cs
diff --git a/src/BeeNet/Clients/GatewayApi/v5_0_0/BeeGatewayClient_5_0_0.cs b/src/BeeNet/Clients/GatewayApi/v5_0_0/BeeGatewayClient_5_0_0.cs
diff --git a/tools/GatewaySwarm.yaml b/tools/GatewaySwarm.yaml
diff --git a/tools/README.md b/tools/README.md
@@ -1,18 +1,25 @@
-Use client generation tool
---------------------------
+# Use client generation tool
 
 NSwag doesn't support multiple OpenAPI configuration files. They needs to be merged.
 
 We are using `speccy` tool (https://github.com/wework/speccy) with these command:
 
-```
-speccy resolve -i .\openapi\Swarm.yaml -o GatewaySwarm.yaml
-speccy resolve -i .\openapi\SwarmDebug.yaml -o DebugSwarm.yaml
+```shell
+speccy resolve -i ./openapi/Swarm.yaml -o GatewaySwarm.yaml
+speccy resolve -i ./openapi/SwarmDebug.yaml -o DebugSwarm.yaml
 ```
 
 How to versioning openapi/*.yaml: 
     - copy *.yaml from official https://github.com/ethersphere/bee/tree/master/openapi in tools/original-open-api
     - merge tools/original-open-api in new feature/BNET-xx-Beex.x.x
 
+# Use Nswag
+
+Use Nswag to generate client code. Use NSwagStudio for Windows, or NSwag Cli with others.
 
+NSwag Cli:
 
+```shell
+nswag run swarm-debug-api.nswag
+nswag run swarm-gateway-api.nswag
+```
diff --git a/tools/openapi/Swarm.yaml b/tools/openapi/Swarm.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 
 info:
-  version: 5.1.0
+  version: 5.1.1
   title: Bee API
   description: "A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages"
 
@@ -158,6 +158,11 @@ paths:
             $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
           required: true
           description: Swarm address reference to content
+        - in: header
+          schema:
+            $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
+          name: swarm-cache
+          required: false
       responses:
         "200":
           description: Retrieved content specified by reference
@@ -300,6 +305,11 @@ paths:
             $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
           required: true
           description: Swarm address of content
+        - in: header
+          schema:
+            $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
+          name: swarm-cache
+          required: false
       responses:
         "200":
           description: Ok
@@ -669,6 +679,14 @@ paths:
             $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
           name: swarm-postage-batch-id
           required: true
+      requestBody:
+        required: true
+        description: The SOC binary data is composed of the span (8 bytes) and the at most 4KB payload.
+        content:
+          application/octet-stream:
+            schema:
+              type: string
+              format: binary
       responses:
         "201":
           description: Created
@@ -1057,6 +1075,11 @@ paths:
             $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
           required: true
           description: Swarm address of chunk
+        - in: header
+          schema:
+            $ref: "SwarmCommon.yaml#/components/parameters/SwarmCache"
+          name: swarm-cache
+          required: false
       responses:
         "200":
           description: Retrieved chunk content
@@ -1896,4 +1919,4 @@ components:
     bearerAuth:
       type: http
       scheme: bearer
-      bearerFormat: SecurityToken
+      bearerFormat: SecurityToken
diff --git a/tools/openapi/SwarmCommon.yaml b/tools/openapi/SwarmCommon.yaml
@@ -1001,6 +1001,15 @@ components:
       description: >
         Determines if the uploaded data should be sent to the network immediately or in a deferred fashion. By default the upload will be direct.
 
+    SwarmCache:
+      in: header
+      name: swarm-cache
+      schema:
+        type: boolean
+        default: "true"
+      required: false
+      description: "Determines if the download data should be cached on the node. By default the download will be cached"
+
   responses:
     "204":
       description: The resource was deleted successfully.
@@ -1039,4 +1048,4 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: "#/components/schemas/ProblemDetails"
+            $ref: "#/components/schemas/ProblemDetails"
diff --git a/tools/openapi/SwarmDebug.yaml b/tools/openapi/SwarmDebug.yaml
@@ -1135,4 +1135,4 @@ paths:
         "400":
           $ref: "SwarmCommon.yaml#/components/responses/400"
         default:
-          description: Default response.
+          description: Default response.
diff --git a/tools/swarm-debug-api.nswag b/tools/swarm-debug-api.nswag
@@ -1,5 +1,5 @@
 {
-  "runtime": "Net70",
+  "runtime": "Net80",
   "defaultVariables": null,
   "documentGenerator": {
     "fromDocument": {
@@ -99,4 +99,4 @@
       "newLineBehavior": "Auto"
     }
   }
-}
+}
diff --git a/tools/swarm-gateway-api.nswag b/tools/swarm-gateway-api.nswag
@@ -1,5 +1,5 @@
 {
-  "runtime": "Net70",
+  "runtime": "Net80",
   "defaultVariables": null,
   "documentGenerator": {
     "fromDocument": {
@@ -99,4 +99,4 @@
       "newLineBehavior": "Auto"
     }
   }
-}
+}