Merge pull request #15 from arangodb-managed/OAS-8974

OAS-8974 | add features to DeploymentModel

data/v1/data.proto

@@ -209,6 +209,16 @@ service DataService {
         };
     }
 
+
+    // Get the deployment model identified by the provided ID.
+    // Required permissions:
+    // - None (authenticated only)
+    rpc GetDeploymentModel(common.v1.IDOptions) returns (DeploymentModel) {
+        option (google.api.http) = {
+            get: "/api/data/v1/deploymentmodel/{id}"
+        };
+    }
+
     // Calculate the total size of a deployment with given arguments.
     // Required permissions:
     // - none
@@ -866,6 +876,12 @@ message DeploymentModel {
     string id = 1;
     // Human readable name of the model (e.g. One shard)
     string name = 2;
+    // Features that are available to deployments of this model type.
+    message Features {
+        // If set, ML is available as a trial only.
+        bool ml_free_trial = 1;
+    }
+    Features features = 3;
 }
 
 // List of deployment models.

data/v1/version.go

@@ -28,5 +28,5 @@ const (
 	// APIMinorVersion contains minor version of this API
 	APIMinorVersion = 8
 	// APIPatchVersion contains patch version of this API
-	APIPatchVersion = 15
+	APIPatchVersion = 16
 )

docs/index.html

@@ -833,6 +833,10 @@ <h2>Table of Contents</h2>
                   <a href="#arangodb.cloud.data.v1.DeploymentModel"><span class="badge">M</span>DeploymentModel</a>
                 </li>
 
+                <li>
+                  <a href="#arangodb.cloud.data.v1.DeploymentModel.Features"><span class="badge">M</span>DeploymentModel.Features</a>
+                </li>
+
                 <li>
                   <a href="#arangodb.cloud.data.v1.DeploymentModelList"><span class="badge">M</span>DeploymentModelList</a>
                 </li>
@@ -10571,6 +10575,37 @@ <h3 id="arangodb.cloud.data.v1.DeploymentModel">DeploymentModel</h3>
                   <td><p>Human readable name of the model (e.g. One shard) </p></td>
                 </tr>
 
+                <tr>
+                  <td>features</td>
+                  <td><a href="#arangodb.cloud.data.v1.DeploymentModel.Features">DeploymentModel.Features</a></td>
+                  <td></td>
+                  <td><p> </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
+        <h3 id="arangodb.cloud.data.v1.DeploymentModel.Features">DeploymentModel.Features</h3>
+        <p>Features that are available to deployments of this model type.</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>ml_free_trial</td>
+                  <td><a href="#bool">bool</a></td>
+                  <td></td>
+                  <td><p>If set, ML is available as a trial only. </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -12280,6 +12315,15 @@ <h3 id="arangodb.cloud.data.v1.DataService">DataService</h3>
 - data.cpusize.list on the requested project</p></td>
               </tr>
 
+              <tr>
+                <td>GetDeploymentModel</td>
+                <td><a href="#arangodb.cloud.common.v1.IDOptions">.arangodb.cloud.common.v1.IDOptions</a></td>
+                <td><a href="#arangodb.cloud.data.v1.DeploymentModel">DeploymentModel</a></td>
+                <td><p>Get the deployment model identified by the provided ID.
+Required permissions:
+- None (authenticated only)</p></td>
+              </tr>
+
               <tr>
                 <td>CalculateDeploymentSize</td>
                 <td><a href="#arangodb.cloud.data.v1.CalculateDeploymentSizeRequest">CalculateDeploymentSizeRequest</a></td>
@@ -12595,6 +12639,16 @@ <h4>Methods with HTTP bindings</h4>
 
 
 
+              <tr>
+                <td>GetDeploymentModel</td>
+                <td>GET</td>
+                <td>/api/data/v1/deploymentmodel/{id}</td>
+                <td></td>
+              </tr>
+
+
+
+
               <tr>
                 <td>CalculateDeploymentSize</td>
                 <td>GET</td>

typescript/data/v1/data.ts

@@ -905,6 +905,16 @@ export interface DeploymentModel {
   // Human readable name of the model (e.g. One shard)
   // string
   name?: string;
+
+  // DeploymentModel_Features
+  features?: DeploymentModel_Features;
+}
+
+// Features that are available to deployments of this model type.
+export interface DeploymentModel_Features {
+  // If set, ML is available as a trial only.
+  // boolean
+  ml_free_trial?: boolean;
 }
 
 // List of deployment models.
@@ -1686,6 +1696,11 @@ export interface IDataService {
   // - data.cpusize.list on the requested project
   ListCPUSizes: (req: ListCPUSizesRequest) => Promise<CPUSizeList>;
 
+  // Get the deployment model identified by the provided ID.
+  // Required permissions:
+  // - None (authenticated only)
+  GetDeploymentModel: (req: arangodb_cloud_common_v1_IDOptions) => Promise<DeploymentModel>;
+
   // Calculate the total size of a deployment with given arguments.
   // Required permissions:
   // - none
@@ -1931,6 +1946,15 @@ export class DataService implements IDataService {
     return api.get(url, undefined);
   }
 
+  // Get the deployment model identified by the provided ID.
+  // Required permissions:
+  // - None (authenticated only)
+  async GetDeploymentModel(req: arangodb_cloud_common_v1_IDOptions): Promise<DeploymentModel> {
+    const path = `/api/data/v1/deploymentmodel/${encodeURIComponent(req.id || '')}`;
+    const url = path + api.queryString(req, [`id`]);
+    return api.get(url, undefined);
+  }
+
   // Calculate the total size of a deployment with given arguments.
   // Required permissions:
   // - none