Also add ability to filter list of app providers by mimetype

cs3org · Apr 26, 2021 · fcbcc8f · fcbcc8f
1 parent 4b6237b
commit fcbcc8f
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 4 deletions.
diff --git a/cs3/app/registry/v1beta1/registry_api.proto b/cs3/app/registry/v1beta1/registry_api.proto
@@ -82,8 +82,24 @@ message ListAppProvidersRequest {
   // OPTIONAL.
   // Opaque information.
   cs3.types.v1beta1.Opaque opaque = 1;
-  // TODO(labkode): maybe add some filter?
-
+  // REQUIRED.
+  // Represents a filter to apply to the request.
+  message Filter {
+    // The filter to apply.
+    enum Type {
+      TYPE_INVALID = 0;
+      TYPE_MIME_TYPE = 1;
+    }
+    // REQUIRED.
+    Type type = 2;
+    oneof term {
+      // if present, the response MUST list all known app providers for the given mimetype.
+      string mime_type = 3;
+    }
+  }
+  // OPTIONAL.
+  // The list of filters to apply if any.
+  repeated Filter filters = 2;
 }
 
 message ListAppProvidersResponse {

diff --git a/docs/index.html b/docs/index.html
@@ -543,11 +543,19 @@ <h2>Table of Contents</h2>
                   <a href="#cs3.app.registry.v1beta1.ListAppProvidersRequest"><span class="badge">M</span>ListAppProvidersRequest</a>
                 </li>
 
+                <li>
+                  <a href="#cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter"><span class="badge">M</span>ListAppProvidersRequest.Filter</a>
+                </li>
+
                 <li>
                   <a href="#cs3.app.registry.v1beta1.ListAppProvidersResponse"><span class="badge">M</span>ListAppProvidersResponse</a>
                 </li>
 
 
+                <li>
+                  <a href="#cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter.Type"><span class="badge">E</span>ListAppProvidersRequest.Filter.Type</a>
+                </li>
+
 
 
                 <li>
@@ -5173,9 +5181,46 @@ <h3 id="cs3.app.registry.v1beta1.ListAppProvidersRequest">ListAppProvidersReques
                   <td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
                   <td></td>
                   <td><p>OPTIONAL.
-Opaque information.
+Opaque information. </p></td>
+                </tr>
+
+                <tr>
+                  <td>filters</td>
+                  <td><a href="#cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter">ListAppProvidersRequest.Filter</a></td>
+                  <td>repeated</td>
+                  <td><p>OPTIONAL.
+The list of filters to apply if any. </p></td>
+                </tr>
+
+            </tbody>
+          </table>
 
-TODO(labkode): maybe add some filter? </p></td>
+
+
+
+
+        <h3 id="cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter">ListAppProvidersRequest.Filter</h3>
+        <p>REQUIRED.</p><p>Represents a filter to apply to the request.</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>type</td>
+                  <td><a href="#cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter.Type">ListAppProvidersRequest.Filter.Type</a></td>
+                  <td></td>
+                  <td><p>REQUIRED. </p></td>
+                </tr>
+
+                <tr>
+                  <td>mime_type</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>if present, the response MUST list all known app providers for the given mimetype. </p></td>
                 </tr>
 
             </tbody>
@@ -5228,6 +5273,29 @@ <h3 id="cs3.app.registry.v1beta1.ListAppProvidersResponse">ListAppProvidersRespo
 
 
 
+        <h3 id="cs3.app.registry.v1beta1.ListAppProvidersRequest.Filter.Type">ListAppProvidersRequest.Filter.Type</h3>
+        <p>The filter to apply.</p>
+        <table class="enum-table">
+          <thead>
+            <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+          </thead>
+          <tbody>
+
+              <tr>
+                <td>TYPE_INVALID</td>
+                <td>0</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>TYPE_MIME_TYPE</td>
+                <td>1</td>
+                <td><p></p></td>
+              </tr>
+
+          </tbody>
+        </table>
+