feat: OpenAPI - declare meta field (#8840)

Author: ovr

packages/cubejs-api-gateway/openspec.yml

@@ -98,6 +98,8 @@ components:
           type: "string"
         shortTitle:
           type: "string"
+        meta:
+          type: "object"
     V1CubeMetaDimensionGranularity:
       type: "object"
       required:
@@ -131,6 +133,8 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/V1CubeMetaDimensionGranularity"
+        meta:
+          type: "object"
     V1CubeMetaMeasure:
       type: "object"
       required:
@@ -147,6 +151,8 @@ components:
           type: "string"
         aggType:
           type: "string"
+        meta:
+          type: "object"
     V1CubeMeta:
       type: "object"
       required:
@@ -162,6 +168,8 @@ components:
           type: "string"
         type:
           $ref: "#/components/schemas/V1CubeMetaType"
+        meta:
+          type: "object"
         description:
           type: "string"
         measures:

rust/cubesql/cubeclient/DEVELOPMENT.md

@@ -33,6 +33,5 @@ The above command will also overwrite `src/apis/default_api.rs`, remember to do
 
 1. Revert block for long polling in `load_v1()`
 2. Revert block containing `tests` module
-3. Rename fields from `r#type` to `_type` (TODO: we can use `--name-mappings type=_type` on new `openapi-generator`)
 
 Finally, run `cargo fmt`

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

@@ -16,6 +16,8 @@ pub struct V1CubeMeta {
     pub title: Option<String>,
     #[serde(rename = "type")]
     pub r#type: crate::models::V1CubeMetaType,
+    #[serde(rename = "meta", skip_serializing_if = "Option::is_none")]
+    pub meta: Option<serde_json::Value>,
     #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
     pub description: Option<String>,
     #[serde(rename = "measures")]
@@ -40,6 +42,7 @@ impl V1CubeMeta {
             name,
             title: None,
             r#type,
+            meta: None,
             description: None,
             measures,
             dimensions,

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

@@ -18,6 +18,8 @@ pub struct V1CubeMetaDimension {
     pub r#type: String,
     #[serde(rename = "granularities", skip_serializing_if = "Option::is_none")]
     pub granularities: Option<Vec<crate::models::V1CubeMetaDimensionGranularity>>,
+    #[serde(rename = "meta", skip_serializing_if = "Option::is_none")]
+    pub meta: Option<serde_json::Value>,
 }
 
 impl V1CubeMetaDimension {
@@ -27,6 +29,7 @@ impl V1CubeMetaDimension {
             description: None,
             r#type,
             granularities: None,
+            meta: None,
         }
     }
 }

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

@@ -20,6 +20,8 @@ pub struct V1CubeMetaMeasure {
     pub r#type: String,
     #[serde(rename = "aggType", skip_serializing_if = "Option::is_none")]
     pub agg_type: Option<String>,
+    #[serde(rename = "meta", skip_serializing_if = "Option::is_none")]
+    pub meta: Option<serde_json::Value>,
 }
 
 impl V1CubeMetaMeasure {
@@ -30,6 +32,7 @@ impl V1CubeMetaMeasure {
             description: None,
             r#type,
             agg_type: None,
+            meta: None,
         }
     }
 }

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

@@ -18,6 +18,8 @@ pub struct V1CubeMetaSegment {
     pub description: Option<String>,
     #[serde(rename = "shortTitle")]
     pub short_title: String,
+    #[serde(rename = "meta", skip_serializing_if = "Option::is_none")]
+    pub meta: Option<serde_json::Value>,
 }
 
 impl V1CubeMetaSegment {
@@ -27,6 +29,7 @@ impl V1CubeMetaSegment {
             title,
             description: None,
             short_title,
+            meta: None,
         }
     }
 }

rust/cubesql/cubesql/benches/large_model.rs

@@ -80,13 +80,15 @@ pub fn get_large_model_test_meta(dims: usize) -> Vec<V1CubeMeta> {
                 description: None,
                 r#type: "number".to_string(),
                 agg_type: Some("count".to_string()),
+                meta: None,
             },
             V1CubeMetaMeasure {
                 name: format!("{}.sum", cube_name),
                 title: None,
                 description: None,
                 r#type: "number".to_string(),
                 agg_type: Some("sum".to_string()),
+                meta: None,
             },
         ],
         dimensions: (1..=dims)
@@ -95,10 +97,12 @@ pub fn get_large_model_test_meta(dims: usize) -> Vec<V1CubeMeta> {
                 description: None,
                 r#type: "number".to_string(),
                 granularities: None,
+                meta: None,
             })
             .collect(),
         segments: vec![],
         joins: None,
+        meta: None,
     }]
 }