Update api spec (#457)

* YOYO NEW API SPEC! * fix Signed-off-by: Jess Frazelle <[email protected]> --------- Signed-off-by: Jess Frazelle <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jess Frazelle <[email protected]>
KittyCAD · Jul 4, 2024 · af1ec9e · af1ec9e
1 parent 1919de1
commit af1ec9e
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 10 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.3.6
+0.3.7
diff --git a/kittycad.rs.patch.json b/kittycad.rs.patch.json
@@ -4,7 +4,7 @@
     "path": "/info/x-rust",
     "value": {
       "client": "// Authenticate via an API token.\nlet client = kittycad::Client::new(\"$TOKEN\");\n\n// - OR -\n\n// Authenticate with your token and host parsed from the environment variables:\n// `KITTYCAD_API_TOKEN`.\nlet client = kittycad::Client::new_from_env();",
-      "install": "[dependencies]\nkittycad = \"0.3.6\""
+      "install": "[dependencies]\nkittycad = \"0.3.7\""
     }
   },
   {

diff --git a/kittycad/Cargo.toml b/kittycad/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "kittycad"
 description = "A fully generated & opinionated API client for the KittyCAD API."
-version = "0.3.6"
+version = "0.3.7"
 documentation = "https://docs.rs/kittycad"
 readme = "README.md"
 repository = "https://github.com/KittyCAD/kittycad.rs/tree/main/kittycad"
@@ -14,7 +14,7 @@ async-trait = { version = "^0.1.53", optional = true }
 base64 = "0.22"
 bigdecimal = { version = "0.4", features = ["serde"] }
 bytes = { version = "1", features = ["serde"] }
-clap = { version = "4.5.8", features = ["cargo", "derive", "env", "unicode"], optional = true }
+clap = { version = "4.2.4", features = ["cargo", "derive", "env", "unicode"], optional = true }
 chrono = { version = "0.4", default-features = false, features = ["serde", "std"] }
 data-encoding = "^2.3.2"
 dirs = { version = "^5.0.1", optional = true }
@@ -23,7 +23,7 @@ futures = { version = "0.3.26", optional = true }
 http = { version = "^0.2.8", optional = true }
 itertools = "0.13.0"
 log = { version = "^0.4", features = ["serde"], optional = true }
-mime_guess = "2.0.5"
+mime_guess = "2.0.4"
 parse-display = "0.9.1"
 phonenumber = "0.3.5"
 rand = { version = "0.8", optional = true }

diff --git a/kittycad/README.md b/kittycad/README.md
@@ -31,7 +31,7 @@ To install the library, add the following to your `Cargo.toml` file.
 
 ```toml
 [dependencies]
-kittycad = "0.3.6"
+kittycad = "0.3.7"
 ```
 
 ## Basic example

diff --git a/kittycad/src/lib.rs b/kittycad/src/lib.rs
@@ -29,7 +29,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! kittycad = "0.3.6"
+//! kittycad = "0.3.7"
 //! ```
 //!
 //! ## Basic example

diff --git a/kittycad/src/modeling.rs b/kittycad/src/modeling.rs
@@ -18,7 +18,8 @@ impl Modeling {
              `fps: Option<u32>`: Frames per second of the video feed.\n- `pool: Option<String>`: \
              An optional identifier for a pool of engine instances. The 'default' pool is used \
              when none is specified.\n- `post_effect: Option<crate::types::PostEffectType>`: \
-             Engine Post effects (such as SSAO)\n- `unlocked_framerate: Option<bool>`: If true, \
+             Engine Post effects (such as SSAO)\n- `show_grid: Option<bool>`: If true, will show \
+             the grid at the start of the session.\n- `unlocked_framerate: Option<bool>`: If true, \
              engine will render video frames as fast as it can.\n- `video_res_height: \
              Option<u32>`: Height of the video feed. Must be a multiple of 4.\n- `video_res_width: \
              Option<u32>`: Width of the video feed. Must be a multiple of 4.\n- `webrtc: \
@@ -30,6 +31,7 @@ impl Modeling {
         fps: Option<u32>,
         pool: Option<String>,
         post_effect: Option<crate::types::PostEffectType>,
+        show_grid: Option<bool>,
         unlocked_framerate: Option<bool>,
         video_res_height: Option<u32>,
         video_res_width: Option<u32>,
@@ -53,6 +55,10 @@ impl Modeling {
             query_params.push(("post_effect", format!("{}", p)));
         }
 
+        if let Some(p) = show_grid {
+            query_params.push(("show_grid", format!("{}", p)));
+        }
+
         if let Some(p) = unlocked_framerate {
             query_params.push(("unlocked_framerate", format!("{}", p)));
         }

diff --git a/kittycad/src/tests.rs b/kittycad/src/tests.rs
@@ -217,7 +217,7 @@ async fn test_modeling_websocket() {
 
     let ws = match client
         .modeling()
-        .commands_ws(None, None, None, None, None, None, None)
+        .commands_ws(None, None, None, None, None, None, None, None)
         .await
     {
         Ok(ws) => ws,

diff --git a/spec.json b/spec.json
@@ -12350,6 +12350,14 @@
               "$ref": "#/components/schemas/PostEffectType"
             }
           },
+          {
+            "in": "query",
+            "name": "show_grid",
+            "description": "If true, will show the grid at the start of the session.",
+            "schema": {
+              "type": "boolean"
+            }
+          },
           {
             "in": "query",
             "name": "unlocked_framerate",