Update api spec (#260)

* YOYO NEW API SPEC! * I have generated the library! --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
KittyCAD · Oct 12, 2023 · 7e087ec · 7e087ec
1 parent 8e43662
commit 7e087ec
Show file tree

Hide file tree

Showing 8 changed files with 183 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
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.2.32\""
+      "install": "[dependencies]\nkittycad = \"0.2.33\""
     }
   },
   {

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.2.32"
+version = "0.2.33"
 documentation = "https://docs.rs/kittycad"
 readme = "README.md"
 repository = "https://github.com/KittyCAD/kittycad.rs/tree/main/kittycad"

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.2.32"
+kittycad = "0.2.33"
 ```
 
 ## Basic example

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

diff --git a/kittycad/src/types.rs b/kittycad/src/types.rs
@@ -6812,6 +6812,14 @@ pub enum ModelingCmd {
         #[doc = "ID of the entity being queried."]
         entity_id: uuid::Uuid,
     },
+    #[doc = "Add a hole to a Solid2d object before extruding it."]
+    #[serde(rename = "solid2d_add_hole")]
+    Solid2DAddHole {
+        #[doc = "The id of the path to use as the inner profile (hole)."]
+        hole_id: uuid::Uuid,
+        #[doc = "Which object to add the hole to."]
+        object_id: uuid::Uuid,
+    },
     #[doc = "Gets all faces which use the given edge."]
     #[serde(rename = "solid3d_get_all_edge_faces")]
     Solid3DGetAllEdgeFaces {
@@ -7121,6 +7129,42 @@ pub enum ModelingCmd {
     GetSketchModePlane {},
 }
 
+#[doc = "A graphics command submitted to the KittyCAD engine via the Modeling API."]
+#[derive(
+    serde :: Serialize, serde :: Deserialize, PartialEq, Debug, Clone, schemars :: JsonSchema,
+)]
+pub struct ModelingCmdReq {
+    #[doc = "Which command to submit to the Kittycad engine."]
+    pub cmd: ModelingCmd,
+    #[doc = "ID of command being submitted."]
+    pub cmd_id: uuid::Uuid,
+}
+
+impl std::fmt::Display for ModelingCmdReq {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
+        write!(
+            f,
+            "{}",
+            serde_json::to_string_pretty(self).map_err(|_| std::fmt::Error)?
+        )
+    }
+}
+
+#[cfg(feature = "tabled")]
+impl tabled::Tabled for ModelingCmdReq {
+    const LENGTH: usize = 2;
+    fn fields(&self) -> Vec<std::borrow::Cow<'static, str>> {
+        vec![
+            format!("{:?}", self.cmd).into(),
+            format!("{:?}", self.cmd_id).into(),
+        ]
+    }
+
+    fn headers() -> Vec<std::borrow::Cow<'static, str>> {
+        vec!["cmd".into(), "cmd_id".into()]
+    }
+}
+
 #[doc = "The response from the `MouseClick` command."]
 #[derive(
     serde :: Serialize, serde :: Deserialize, PartialEq, Debug, Clone, schemars :: JsonSchema,
@@ -11419,6 +11463,14 @@ pub enum WebSocketRequest {
         #[doc = "ID of command being submitted."]
         cmd_id: uuid::Uuid,
     },
+    #[doc = "A sequence of modeling requests. If any request fails, following requests will not \
+             be tried."]
+    #[serde(rename = "modeling_cmd_batch_req")]
+    ModelingCmdBatchReq {
+        #[doc = "A sequence of modeling requests. If any request fails, following requests will \
+                 not be tried."]
+        requests: Vec<ModelingCmdReq>,
+    },
     #[doc = "The client-to-server Ping to ensure the WebSocket stays alive."]
     #[serde(rename = "ping")]
     Ping {},

diff --git a/openapitor/tests/types/kittycad.rs.gen b/openapitor/tests/types/kittycad.rs.gen
@@ -6685,6 +6685,14 @@ pub enum ModelingCmd {
         #[doc = "ID of the entity being queried."]
         entity_id: uuid::Uuid,
     },
+    #[doc = "Add a hole to a Solid2d object before extruding it."]
+    #[serde(rename = "solid2d_add_hole")]
+    Solid2DAddHole {
+        #[doc = "The id of the path to use as the inner profile (hole)."]
+        hole_id: uuid::Uuid,
+        #[doc = "Which object to add the hole to."]
+        object_id: uuid::Uuid,
+    },
     #[doc = "Gets all faces which use the given edge."]
     #[serde(rename = "solid3d_get_all_edge_faces")]
     Solid3DGetAllEdgeFaces {
@@ -6977,6 +6985,42 @@ pub enum ModelingCmd {
     GetSketchModePlane {},
 }
 
+#[doc = "A graphics command submitted to the KittyCAD engine via the Modeling API."]
+#[derive(
+    serde :: Serialize, serde :: Deserialize, PartialEq, Debug, Clone, schemars :: JsonSchema,
+)]
+pub struct ModelingCmdReq {
+    #[doc = "Which command to submit to the Kittycad engine."]
+    pub cmd: ModelingCmd,
+    #[doc = "ID of command being submitted."]
+    pub cmd_id: uuid::Uuid,
+}
+
+impl std::fmt::Display for ModelingCmdReq {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
+        write!(
+            f,
+            "{}",
+            serde_json::to_string_pretty(self).map_err(|_| std::fmt::Error)?
+        )
+    }
+}
+
+#[cfg(feature = "tabled")]
+impl tabled::Tabled for ModelingCmdReq {
+    const LENGTH: usize = 2;
+    fn fields(&self) -> Vec<std::borrow::Cow<'static, str>> {
+        vec![
+            format!("{:?}", self.cmd).into(),
+            format!("{:?}", self.cmd_id).into(),
+        ]
+    }
+
+    fn headers() -> Vec<std::borrow::Cow<'static, str>> {
+        vec!["cmd".into(), "cmd_id".into()]
+    }
+}
+
 #[doc = "The response from the `MouseClick` command."]
 #[derive(
     serde :: Serialize, serde :: Deserialize, PartialEq, Debug, Clone, schemars :: JsonSchema,
@@ -11233,6 +11277,12 @@ pub enum WebSocketRequest {
         #[doc = "ID of command being submitted."]
         cmd_id: uuid::Uuid,
     },
+    #[doc = "A sequence of modeling requests. If any request fails, following requests will not be tried."]
+    #[serde(rename = "modeling_cmd_batch_req")]
+    ModelingCmdBatchReq {
+        #[doc = "A sequence of modeling requests. If any request fails, following requests will not be tried."]
+        requests: Vec<ModelingCmdReq>,
+    },
     #[doc = "The client-to-server Ping to ensure the WebSocket stays alive."]
     #[serde(rename = "ping")]
     Ping {},

diff --git a/spec.json b/spec.json
@@ -12559,6 +12559,33 @@
               "type"
             ]
           },
+          {
+            "description": "Add a hole to a Solid2d object before extruding it.",
+            "type": "object",
+            "properties": {
+              "hole_id": {
+                "description": "The id of the path to use as the inner profile (hole).",
+                "type": "string",
+                "format": "uuid"
+              },
+              "object_id": {
+                "description": "Which object to add the hole to.",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "solid2d_add_hole"
+                ]
+              }
+            },
+            "required": [
+              "hole_id",
+              "object_id",
+              "type"
+            ]
+          },
           {
             "description": "Gets all faces which use the given edge.",
             "type": "object",
@@ -13646,6 +13673,32 @@
         "type": "string",
         "format": "uuid"
       },
+      "ModelingCmdReq": {
+        "description": "A graphics command submitted to the KittyCAD engine via the Modeling API.",
+        "type": "object",
+        "properties": {
+          "cmd": {
+            "description": "Which command to submit to the Kittycad engine.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ModelingCmd"
+              }
+            ]
+          },
+          "cmd_id": {
+            "description": "ID of command being submitted.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ModelingCmdId"
+              }
+            ]
+          }
+        },
+        "required": [
+          "cmd",
+          "cmd_id"
+        ]
+      },
       "MouseClick": {
         "description": "The response from the `MouseClick` command.",
         "type": "object",
@@ -17689,6 +17742,29 @@
               "type"
             ]
           },
+          {
+            "description": "A sequence of modeling requests. If any request fails, following requests will not be tried.",
+            "type": "object",
+            "properties": {
+              "requests": {
+                "description": "A sequence of modeling requests. If any request fails, following requests will not be tried.",
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ModelingCmdReq"
+                }
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "modeling_cmd_batch_req"
+                ]
+              }
+            },
+            "required": [
+              "requests",
+              "type"
+            ]
+          },
           {
             "description": "The client-to-server Ping to ensure the WebSocket stays alive.",
             "type": "object",