add delete home to the storage provider

added a delete home method to the storage provider to be able to clean up when removing a user Signed-off-by: David Christofas <dchristofas@owncloud.com>
cs3org · Nov 4, 2020 · b9c5fb8 · b9c5fb8
1 parent a6cf2aa
commit b9c5fb8
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 1 deletion.
diff --git a/cs3/gateway/v1beta1/gateway_api.proto b/cs3/gateway/v1beta1/gateway_api.proto
@@ -151,6 +151,8 @@ service GatewayAPI {
   rpc UnsetArbitraryMetadata(cs3.storage.provider.v1beta1.UnsetArbitraryMetadataRequest) returns (cs3.storage.provider.v1beta1.UnsetArbitraryMetadataResponse);
   // Creates the home directory for a user.
   rpc CreateHome(cs3.storage.provider.v1beta1.CreateHomeRequest) returns (cs3.storage.provider.v1beta1.CreateHomeResponse);
+  // Deletes the home directory for a user.
+  rpc DeleteHome(cs3.storage.provider.v1beta1.DeleteHomeRequest) returns (cs3.storage.provider.v1beta1.DeleteHomeResponse);
   // *****************************************************************/
   // ************************ APP PROVIDER ********************/
   // *****************************************************************/

diff --git a/cs3/storage/provider/v1beta1/provider_api.proto b/cs3/storage/provider/v1beta1/provider_api.proto
@@ -144,6 +144,8 @@ service ProviderAPI {
   rpc CreateHome(CreateHomeRequest) returns (CreateHomeResponse);
   // Gets the home path for the user.
   rpc GetHome(GetHomeRequest) returns (GetHomeResponse);
+  // Deletes the home directory for a user.
+  rpc DeleteHome(DeleteHomeRequest) returns (DeleteHomeResponse);
 }
 
 message GetHomeRequest {
@@ -724,3 +726,18 @@ message CreateHomeResponse {
   // Opaque information.
   cs3.types.v1beta1.Opaque opaque = 2;
 }
+
+message DeleteHomeRequest {
+  // OPTIONAL.
+  // Opaque information.
+  cs3.types.v1beta1.Opaque opaque = 1;
+}
+
+message DeleteHomeResponse {
+  // REQUIRED.
+  // The response status.
+  cs3.rpc.v1beta1.Status status = 1;
+  // OPTIONAL.
+  // Opaque information.
+  cs3.types.v1beta1.Opaque opaque = 2;
+}
diff --git a/docs/index.html b/docs/index.html
@@ -1219,6 +1219,14 @@ <h2>Table of Contents</h2>
                   <a href="#cs3.storage.provider.v1beta1.CreateSymlinkResponse"><span class="badge">M</span>CreateSymlinkResponse</a>
                 </li>
 
+                <li>
+                  <a href="#cs3.storage.provider.v1beta1.DeleteHomeRequest"><span class="badge">M</span>DeleteHomeRequest</a>
+                </li>
+
+                <li>
+                  <a href="#cs3.storage.provider.v1beta1.DeleteHomeResponse"><span class="badge">M</span>DeleteHomeResponse</a>
+                </li>
+
                 <li>
                   <a href="#cs3.storage.provider.v1beta1.DeleteRequest"><span class="badge">M</span>DeleteRequest</a>
                 </li>
@@ -2333,7 +2341,14 @@ <h3 id="cs3.gateway.v1beta1.GatewayAPI">GatewayAPI</h3>
                 <td>CreateHome</td>
                 <td><a href="#cs3.storage.provider.v1beta1.CreateHomeRequest">.cs3.storage.provider.v1beta1.CreateHomeRequest</a></td>
                 <td><a href="#cs3.storage.provider.v1beta1.CreateHomeResponse">.cs3.storage.provider.v1beta1.CreateHomeResponse</a></td>
-                <td><p>Creates the home directory for a user.
+                <td><p>Creates the home directory for a user.</p></td>
+              </tr>
+
+              <tr>
+                <td>DeleteHome</td>
+                <td><a href="#cs3.storage.provider.v1beta1.DeleteHomeRequest">.cs3.storage.provider.v1beta1.DeleteHomeRequest</a></td>
+                <td><a href="#cs3.storage.provider.v1beta1.DeleteHomeResponse">.cs3.storage.provider.v1beta1.DeleteHomeResponse</a></td>
+                <td><p>Deletes the home directory for a user.
 
 *****************************************************************/
 ************************ APP PROVIDER ********************/
@@ -10052,6 +10067,64 @@ <h3 id="cs3.storage.provider.v1beta1.CreateSymlinkResponse">CreateSymlinkRespons
 
 
 
+        <h3 id="cs3.storage.provider.v1beta1.DeleteHomeRequest">DeleteHomeRequest</h3>
+        <p></p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>opaque</td>
+                  <td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+Opaque information. </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
+        <h3 id="cs3.storage.provider.v1beta1.DeleteHomeResponse">DeleteHomeResponse</h3>
+        <p></p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>status</td>
+                  <td><a href="#cs3.rpc.v1beta1.Status">cs3.rpc.v1beta1.Status</a></td>
+                  <td></td>
+                  <td><p>REQUIRED.
+The response status. </p></td>
+                </tr>
+
+                <tr>
+                  <td>opaque</td>
+                  <td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+Opaque information. </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
         <h3 id="cs3.storage.provider.v1beta1.DeleteRequest">DeleteRequest</h3>
         <p></p>
 
@@ -11915,6 +11988,13 @@ <h3 id="cs3.storage.provider.v1beta1.ProviderAPI">ProviderAPI</h3>
                 <td><p>Gets the home path for the user.</p></td>
               </tr>
 
+              <tr>
+                <td>DeleteHome</td>
+                <td><a href="#cs3.storage.provider.v1beta1.DeleteHomeRequest">DeleteHomeRequest</a></td>
+                <td><a href="#cs3.storage.provider.v1beta1.DeleteHomeResponse">DeleteHomeResponse</a></td>
+                <td><p>Deletes the home directory for a user.</p></td>
+              </tr>
+
           </tbody>
         </table>