chore: docs

ethersphere · Nov 13, 2023 · 143eda9 · 143eda9
1 parent 587d674
commit 143eda9
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/openapi/Swarm.yaml b/openapi/Swarm.yaml
@@ -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

diff --git a/openapi/SwarmCommon.yaml b/openapi/SwarmCommon.yaml
@@ -985,6 +985,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.