update the storageprovider recycle api

Added a reference for the target resource on which the action should be executed. This is necessary because we want to be able to perform actions for specific resources in the recycle file tree and not only on the root of a deleted tree.
cs3org · Jun 29, 2021 · 928f346 · 928f346
1 parent 1a4ab6b
commit 928f346
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 22 deletions.
diff --git a/cs3/storage/provider/v1beta1/provider_api.proto b/cs3/storage/provider/v1beta1/provider_api.proto
@@ -426,15 +426,18 @@ message ListRecycleRequest {
   // Opaque information.
   cs3.types.v1beta1.Opaque opaque = 1;
   // OPTIONAL.
+  // The reference to which the action should be performed.
+  Reference ref = 2;
+  // OPTIONAL.
   // SHOULD be specified.
   // The start time range to query for recycle items.
   // The value is the Unix Epoch timestamp in seconds.
-  cs3.types.v1beta1.Timestamp from_ts = 2;
+  cs3.types.v1beta1.Timestamp from_ts = 3;
   // OPTIONAL.
   // SHOULD be specified.
   // The end time range to query for recycle items.
   // The value is Unix Epoch timestamp in seconds.
-  cs3.types.v1beta1.Timestamp to_ts = 3;
+  cs3.types.v1beta1.Timestamp to_ts = 4;
 }
 
 message ListRecycleResponse {
@@ -454,15 +457,18 @@ message ListRecycleStreamRequest {
   // Opaque information.
   cs3.types.v1beta1.Opaque opaque = 1;
   // OPTIONAL.
+  // The reference to which the action should be performed.
+  Reference ref = 2;
+  // OPTIONAL.
   // SHOULD be specified.
   // The start time range to query for recycle items.
   // The value is the Unix Epoch timestamp in seconds.
-  cs3.types.v1beta1.Timestamp from_ts = 2;
+  cs3.types.v1beta1.Timestamp from_ts = 3;
   // OPTIONAL.
   // SHOULD be specified.
   // The end time range to query for recycle items.
   // The value is Unix Epoch timestamp in seconds.
-  cs3.types.v1beta1.Timestamp to_ts = 3;
+  cs3.types.v1beta1.Timestamp to_ts = 4;
 }
 
 message ListRecycleStreamResponse {
@@ -545,9 +551,6 @@ message RestoreRecycleItemRequest {
   // REQUIRED.
   // The reference to which the action should be performed.
   Reference ref = 2;
-  // REQUIRED.
-  // The key for the recycle item to be restored.
-  string key = 3;
   // OPTIONAL.
   // An optional restore path for the deleted resource.
   // It can be useful to restore to another location rather than

diff --git a/docs/index.html b/docs/index.html
@@ -13785,6 +13785,14 @@ <h3 id="cs3.storage.provider.v1beta1.ListRecycleRequest">ListRecycleRequest</h3>
 Opaque information. </p></td>
                 </tr>
 
+                <tr>
+                  <td>ref</td>
+                  <td><a href="#cs3.storage.provider.v1beta1.Reference">Reference</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+The reference to which the action should be performed. </p></td>
+                </tr>
+
                 <tr>
                   <td>from_ts</td>
                   <td><a href="#cs3.types.v1beta1.Timestamp">cs3.types.v1beta1.Timestamp</a></td>
@@ -13871,6 +13879,14 @@ <h3 id="cs3.storage.provider.v1beta1.ListRecycleStreamRequest">ListRecycleStream
 Opaque information. </p></td>
                 </tr>
 
+                <tr>
+                  <td>ref</td>
+                  <td><a href="#cs3.storage.provider.v1beta1.Reference">Reference</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+The reference to which the action should be performed. </p></td>
+                </tr>
+
                 <tr>
                   <td>from_ts</td>
                   <td><a href="#cs3.types.v1beta1.Timestamp">cs3.types.v1beta1.Timestamp</a></td>
@@ -14371,14 +14387,6 @@ <h3 id="cs3.storage.provider.v1beta1.RestoreRecycleItemRequest">RestoreRecycleIt
 The reference to which the action should be performed. </p></td>
                 </tr>
 
-                <tr>
-                  <td>key</td>
-                  <td><a href="#string">string</a></td>
-                  <td></td>
-                  <td><p>REQUIRED.
-The key for the recycle item to be restored. </p></td>
-                </tr>
-
                 <tr>
                   <td>restore_ref</td>
                   <td><a href="#cs3.storage.provider.v1beta1.Reference">Reference</a></td>

diff --git a/proto.lock b/proto.lock
@@ -6922,11 +6922,16 @@
               },
               {
                 "id": 2,
+                "name": "ref",
+                "type": "Reference"
+              },
+              {
+                "id": 3,
                 "name": "from_ts",
                 "type": "cs3.types.v1beta1.Timestamp"
               },
               {
-                "id": 3,
+                "id": 4,
                 "name": "to_ts",
                 "type": "cs3.types.v1beta1.Timestamp"
               }
@@ -6963,11 +6968,16 @@
               },
               {
                 "id": 2,
+                "name": "ref",
+                "type": "Reference"
+              },
+              {
+                "id": 3,
                 "name": "from_ts",
                 "type": "cs3.types.v1beta1.Timestamp"
               },
               {
-                "id": 3,
+                "id": 4,
                 "name": "to_ts",
                 "type": "cs3.types.v1beta1.Timestamp"
               }
@@ -7106,11 +7116,6 @@
                 "name": "ref",
                 "type": "Reference"
               },
-              {
-                "id": 3,
-                "name": "key",
-                "type": "string"
-              },
               {
                 "id": 4,
                 "name": "restore_ref",