feat: OpenAPI - declare type field for Cube (#8837)

Author: ovr

packages/cubejs-api-gateway/openspec.yml

@@ -151,6 +151,7 @@ components:
       type: "object"
       required:
         - name
+        - type
         - measures
         - dimensions
         - segments
@@ -159,6 +160,8 @@ components:
           type: "string"
         title:
           type: "string"
+        type:
+          $ref: "#/components/schemas/V1CubeMetaType"
         description:
           type: "string"
         measures:
@@ -177,6 +180,12 @@ components:
           type: "array"
           items:
             $ref: "#/components/schemas/V1CubeMetaJoin"
+    V1CubeMetaType:
+      type: "string"
+      description: Type of cube
+      enum:
+        - "cube"
+        - "view"
     V1MetaResponse:
       type: "object"
       properties:

packages/cubejs-backend-native/test/meta.js

@@ -5,6 +5,7 @@ module.exports = {
     {
       name: 'KibanaSampleDataEcommerce',
       title: 'Ecommerce',
+      type: 'cube',
       measures: [
         {
           name: 'KibanaSampleDataEcommerce.count',
@@ -126,6 +127,7 @@ module.exports = {
     {
       name: 'Logs',
       title: 'Logs',
+      type: 'cube',
       measures: [
         {
           name: 'Logs.count',

rust/cubesql/cubeclient/.openapi-generator/FILES

@@ -7,6 +7,7 @@ src/models/v1_cube_meta_dimension_granularity.rs
 src/models/v1_cube_meta_join.rs
 src/models/v1_cube_meta_measure.rs
 src/models/v1_cube_meta_segment.rs
+src/models/v1_cube_meta_type.rs
 src/models/v1_error.rs
 src/models/v1_load_request.rs
 src/models/v1_load_request_query.rs

rust/cubesql/cubeclient/src/lib.rs

@@ -1,3 +1,7 @@
+// Open spec generator generates ToString methods for enums, let's disable clippy rule as quick
+// workaround. TODO: Use new one open spec generator?
+#![allow(clippy::to_string_trait_impl)]
+
 #[macro_use]
 extern crate serde_derive;
 

rust/cubesql/cubeclient/src/models/mod.rs

@@ -10,6 +10,8 @@ pub mod v1_cube_meta_measure;
 pub use self::v1_cube_meta_measure::V1CubeMetaMeasure;
 pub mod v1_cube_meta_segment;
 pub use self::v1_cube_meta_segment::V1CubeMetaSegment;
+pub mod v1_cube_meta_type;
+pub use self::v1_cube_meta_type::V1CubeMetaType;
 pub mod v1_error;
 pub use self::v1_error::V1Error;
 pub mod v1_load_request;

rust/cubesql/cubeclient/src/models/v1_cube_meta.rs

@@ -14,6 +14,8 @@ pub struct V1CubeMeta {
     pub name: String,
     #[serde(rename = "title", skip_serializing_if = "Option::is_none")]
     pub title: Option<String>,
+    #[serde(rename = "type")]
+    pub r#type: crate::models::V1CubeMetaType,
     #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
     pub description: Option<String>,
     #[serde(rename = "measures")]
@@ -29,13 +31,15 @@ pub struct V1CubeMeta {
 impl V1CubeMeta {
     pub fn new(
         name: String,
+        r#type: crate::models::V1CubeMetaType,
         measures: Vec<crate::models::V1CubeMetaMeasure>,
         dimensions: Vec<crate::models::V1CubeMetaDimension>,
         segments: Vec<crate::models::V1CubeMetaSegment>,
     ) -> V1CubeMeta {
         V1CubeMeta {
             name,
             title: None,
+            r#type,
             description: None,
             measures,
             dimensions,

rust/cubesql/cubeclient/src/models/v1_cube_meta_dimension.rs

@@ -15,17 +15,17 @@ pub struct V1CubeMetaDimension {
     #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
     pub description: Option<String>,
     #[serde(rename = "type")]
-    pub _type: String,
+    pub r#type: String,
     #[serde(rename = "granularities", skip_serializing_if = "Option::is_none")]
     pub granularities: Option<Vec<crate::models::V1CubeMetaDimensionGranularity>>,
 }
 
 impl V1CubeMetaDimension {
-    pub fn new(name: String, _type: String) -> V1CubeMetaDimension {
+    pub fn new(name: String, r#type: String) -> V1CubeMetaDimension {
         V1CubeMetaDimension {
             name,
             description: None,
-            _type,
+            r#type,
             granularities: None,
         }
     }

rust/cubesql/cubeclient/src/models/v1_cube_meta_measure.rs

@@ -17,18 +17,18 @@ pub struct V1CubeMetaMeasure {
     #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
     pub description: Option<String>,
     #[serde(rename = "type")]
-    pub _type: String,
+    pub r#type: String,
     #[serde(rename = "aggType", skip_serializing_if = "Option::is_none")]
     pub agg_type: Option<String>,
 }
 
 impl V1CubeMetaMeasure {
-    pub fn new(name: String, _type: String) -> V1CubeMetaMeasure {
+    pub fn new(name: String, r#type: String) -> V1CubeMetaMeasure {
         V1CubeMetaMeasure {
             name,
             title: None,
             description: None,
-            _type,
+            r#type,
             agg_type: None,
         }
     }

rust/cubesql/cubeclient/src/models/v1_cube_meta_type.rs

@@ -0,0 +1,35 @@
+/*
+ * Cube.js
+ *
+ * Cube.js Swagger Schema
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ * Generated by: https://openapi-generator.tech
+ */
+
+/// V1CubeMetaType : Type of cube
+
+/// Type of cube
+#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
+pub enum V1CubeMetaType {
+    #[serde(rename = "cube")]
+    Cube,
+    #[serde(rename = "view")]
+    View,
+}
+
+impl ToString for V1CubeMetaType {
+    fn to_string(&self) -> String {
+        match self {
+            Self::Cube => String::from("cube"),
+            Self::View => String::from("view"),
+        }
+    }
+}
+
+impl Default for V1CubeMetaType {
+    fn default() -> V1CubeMetaType {
+        Self::Cube
+    }
+}

rust/cubesql/cubesql/benches/large_model.rs

@@ -2,7 +2,7 @@ use std::{env::set_var, sync::Arc, time::Duration};
 
 use criterion::{criterion_group, criterion_main, Criterion};
 
-use cubeclient::models::{V1CubeMeta, V1CubeMetaDimension, V1CubeMetaMeasure};
+use cubeclient::models::{V1CubeMeta, V1CubeMetaDimension, V1CubeMetaMeasure, V1CubeMetaType};
 use cubesql::{
     compile::test::{
         rewrite_engine::{
@@ -72,27 +72,28 @@ pub fn get_large_model_test_meta(dims: usize) -> Vec<V1CubeMeta> {
         name: cube_name.clone(),
         description: None,
         title: None,
+        r#type: V1CubeMetaType::Cube,
         measures: vec![
             V1CubeMetaMeasure {
                 name: format!("{}.count", cube_name),
                 title: None,
                 description: None,
-                _type: "number".to_string(),
+                r#type: "number".to_string(),
                 agg_type: Some("count".to_string()),
             },
             V1CubeMetaMeasure {
                 name: format!("{}.sum", cube_name),
                 title: None,
                 description: None,
-                _type: "number".to_string(),
+                r#type: "number".to_string(),
                 agg_type: Some("sum".to_string()),
             },
         ],
         dimensions: (1..=dims)
             .map(|n| V1CubeMetaDimension {
                 name: format!("{}.n{}", cube_name, n),
                 description: None,
-                _type: "number".to_string(),
+                r#type: "number".to_string(),
                 granularities: None,
             })
             .collect(),