chore: note lack of unpin on filecoin

blockfrost · Dec 1, 2024 · 6ee3e2a · 6ee3e2a
1 parent b683d2a
commit 6ee3e2a
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 22 deletions.
diff --git a/blockfrost-openapi.yaml b/blockfrost-openapi.yaml
@@ -5455,7 +5455,10 @@ paths:
       tags:
         - IPFS » Pins
       summary: Pin an object
-      description: Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.
+      description: |
+        Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true
@@ -5469,7 +5472,7 @@ paths:
             type: boolean
           required: false
           description: |
-            If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS.
+            If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS. Objects pinned to Filecoin cannot be unpinned due to its long-term storage guarantees.
       x-codeSamples:
         - lang: Shell
           label: cURL
@@ -5731,6 +5734,8 @@ paths:
         <p>
           <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
         </p>
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true

diff --git a/docs/blockfrost-openapi.yaml b/docs/blockfrost-openapi.yaml
@@ -5708,10 +5708,16 @@ paths:
       tags:
         - IPFS » Pins
       summary: Pin an object
-      description: >-
+      description: >
         Pinning is necessary to avoid regular garbage collection (deletion) of
         IPFS objects. Non-pinned objects are regularly being removed without
         prior notice. Pinned objects are counted in your user storage quota.
+
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`),
+        it cannot be removed or unpinned due to Filecoin's immutable and
+        persistent storage guarantees. Please ensure careful consideration when
+        pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true
@@ -5726,7 +5732,9 @@ paths:
           required: false
           description: >
             If set to true, the object will be pinned to Filecoin as well. If
-            not specified, the object will only be pinned to IPFS.
+            not specified, the object will only be pinned to IPFS. Objects
+            pinned to Filecoin cannot be unpinned due to its long-term storage
+            guarantees.
       x-codeSamples:
         - lang: Shell
           label: cURL
@@ -6002,12 +6010,19 @@ paths:
       tags:
         - IPFS » Pins
       summary: Remove a IPFS pin
-      description: |
+      description: >
         Remove pinned objects from local storage
 
+
         <p>
           <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
         </p>
+
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`),
+        it cannot be removed or unpinned due to Filecoin's immutable and
+        persistent storage guarantees. Please ensure careful consideration when
+        pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true

diff --git a/openapi.json b/openapi.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "0.1.69",
+    "version": "0.1.70",
     "title": "Blockfrost.io ~ API Documentation",
     "x-logo": {
       "url": "https://staging.blockfrost.io/images/logo.svg",
@@ -7323,13 +7323,6 @@
         "summary": "Add a file to IPFS",
         "operationId": "ipfs_add",
         "description": "You need to `/ipfs/pin/add` an object to avoid it being garbage collected. This usage\nis being counted in your user account quota.\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n",
-        "x-codeSamples": [
-          {
-            "lang": "Shell",
-            "label": "cURL",
-            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/add\" \\\n  -X POST \\\n  -H \"project_id: $PROJECT_ID\" \\\n  -F \"file=@./README.md\"\n"
-          }
-        ],
         "requestBody": {
           "content": {
             "multipart/form-data": {
@@ -7345,6 +7338,13 @@
             }
           }
         },
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/add\" \\\n  -X POST \\\n  -H \"project_id: $PROJECT_ID\" \\\n  -F \"file=@./README.md\"\n"
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns information about added IPFS object",
@@ -7411,6 +7411,13 @@
         ],
         "summary": "Relay to an IPFS gateway",
         "description": "Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n",
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/gateway/{IPFS_path}\" \\\n  -H \"project_id: $PROJECT_ID\" \\\n"
+          }
+        ],
         "parameters": [
           {
             "in": "path",
@@ -7466,7 +7473,7 @@
           "IPFS » Pins"
         ],
         "summary": "Pin an object",
-        "description": "Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.",
+        "description": "Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.\n\n**Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.\n",
         "parameters": [
           {
             "in": "path",
@@ -7484,7 +7491,14 @@
               "type": "boolean"
             },
             "required": false,
-            "description": "If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS.\n"
+            "description": "If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS. Objects pinned to Filecoin cannot be unpinned due to its long-term storage guarantees.\n"
+          }
+        ],
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/pin/add/{IPFS_path}\" \\\n  -H \"project_id: $PROJECT_ID\" \\\n"
           }
         ],
         "responses": {
@@ -7602,6 +7616,13 @@
             "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n"
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/pin/list/\" \\\n  -H \"project_id: $PROJECT_ID\" \\\n"
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns pinned objects",
@@ -7706,6 +7727,13 @@
             }
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/pin/list/{IPFS_PATH}\" \\\n  -H \"project_id: $PROJECT_ID\" \\\n"
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns the pins pinned",
@@ -7795,7 +7823,7 @@
           "IPFS » Pins"
         ],
         "summary": "Remove a IPFS pin",
-        "description": "Remove pinned objects from local storage\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n",
+        "description": "Remove pinned objects from local storage\n\n<p>\n  <span class=\"hosted\">Hosted</span> Endpoint only available for hosted variant.\n</p>\n\n**Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.\n",
         "parameters": [
           {
             "in": "path",
@@ -7807,6 +7835,13 @@
             }
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "Shell",
+            "label": "cURL",
+            "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/pin/remove/{IPFS_PATH}\" \\\n  -X POST \\\n  -H \"project_id: $PROJECT_ID\" \\\n"
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns the pins removed",

diff --git a/openapi.yaml b/openapi.yaml
@@ -5708,10 +5708,16 @@ paths:
       tags:
         - IPFS » Pins
       summary: Pin an object
-      description: >-
+      description: >
         Pinning is necessary to avoid regular garbage collection (deletion) of
         IPFS objects. Non-pinned objects are regularly being removed without
         prior notice. Pinned objects are counted in your user storage quota.
+
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`),
+        it cannot be removed or unpinned due to Filecoin's immutable and
+        persistent storage guarantees. Please ensure careful consideration when
+        pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true
@@ -5726,7 +5732,9 @@ paths:
           required: false
           description: >
             If set to true, the object will be pinned to Filecoin as well. If
-            not specified, the object will only be pinned to IPFS.
+            not specified, the object will only be pinned to IPFS. Objects
+            pinned to Filecoin cannot be unpinned due to its long-term storage
+            guarantees.
       x-codeSamples:
         - lang: Shell
           label: cURL
@@ -6002,12 +6010,19 @@ paths:
       tags:
         - IPFS » Pins
       summary: Remove a IPFS pin
-      description: |
+      description: >
         Remove pinned objects from local storage
 
+
         <p>
           <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
         </p>
+
+
+        **Note:** If the object was pinned to Filecoin (using `filecoin=true`),
+        it cannot be removed or unpinned due to Filecoin's immutable and
+        persistent storage guarantees. Please ensure careful consideration when
+        pinning objects to Filecoin, as the action is irreversible.
       parameters:
         - in: path
           required: true

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -5835,11 +5835,14 @@ export interface paths {
         /**
          * Pin an object
          * @description Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.
+         *
+         *     **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
+         *
          */
         post: {
             parameters: {
                 query?: {
-                    /** @description If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS.
+                    /** @description If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS. Objects pinned to Filecoin cannot be unpinned due to its long-term storage guarantees.
                      *      */
                     filecoin?: boolean;
                 };
@@ -6084,6 +6087,8 @@ export interface paths {
          *       <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
          *     </p>
          *
+         *     **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
+         *
          */
         post: {
             parameters: {

diff --git a/src/paths/ipfs/pin/add/{IPFS_path}/index.yaml b/src/paths/ipfs/pin/add/{IPFS_path}/index.yaml
@@ -4,7 +4,10 @@ post:
   tags:
     - IPFS » Pins
   summary: Pin an object
-  description: Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.
+  description: |
+    Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.
+
+    **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
   parameters:
     - in: path
       required: true
@@ -18,7 +21,7 @@ post:
         type: boolean
       required: false
       description: >
-        If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS.
+        If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS. Objects pinned to Filecoin cannot be unpinned due to its long-term storage guarantees.
   x-codeSamples:
     - lang: "Shell"
       label: "cURL"

diff --git a/src/paths/ipfs/pin/remove/{IPFS_path}/index.yaml b/src/paths/ipfs/pin/remove/{IPFS_path}/index.yaml
@@ -10,6 +10,8 @@ post:
     <p>
       <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
     </p>
+
+    **Note:** If the object was pinned to Filecoin (using `filecoin=true`), it cannot be removed or unpinned due to Filecoin's immutable and persistent storage guarantees. Please ensure careful consideration when pinning objects to Filecoin, as the action is irreversible.
   parameters:
     - in: path
       required: true