Update api spec (#463)

* YOYO NEW API SPEC! * updates Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * I have generated the library! --------- 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 9, 2024 · 546d460 · 546d460
1 parent d863f82
commit 546d460
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 23 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.3.7
+0.3.8
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.7\""
+      "install": "[dependencies]\nkittycad = \"0.3.8\""
     }
   },
   {
@@ -123,7 +123,7 @@
     "op": "add",
     "path": "/paths/~1async~1operations~1{id}/get/x-rust",
     "value": {
-      "example": "/// Get an async operation.\n/// \n/// Get the status and output of an async operation.\n/// This endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user.\n/// If the user is not authenticated to view the specified async operation, then it is not returned.\n/// Only Zoo employees with the proper access can view async operations for other users.\n/// \n/// **Parameters:**\n/// \n/// - `id: &'astr`: The ID of the async operation. (required)\nasync fn example_api_calls_get_async_operation() -> anyhow::Result<()> {\n    let client = kittycad::Client::new_from_env();\n    let result: kittycad::types::AsyncApiCallOutput = client\n        .api_calls()\n        .get_async_operation(\"some-string\")\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n",
+      "example": "/// Get an async operation.\n/// \n/// Get the status and output of an async operation.\n/// This endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user.\n/// If the user is not authenticated to view the specified async operation, then it is not returned.\n/// Only Zoo employees with the proper access can view async operations for other users.\n/// \n/// **Parameters:**\n/// \n/// - `id: uuid::Uuid`: The ID of the async operation. (required)\nuse std::str::FromStr;\nasync fn example_api_calls_get_async_operation() -> anyhow::Result<()> {\n    let client = kittycad::Client::new_from_env();\n    let result: kittycad::types::AsyncApiCallOutput = client\n        .api_calls()\n        .get_async_operation(uuid::Uuid::from_str(\n            \"d9797f8d-9ad6-4e08-90d7-2ec17e13471c\",\n        )?)\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n",
       "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.get_async_operation"
     }
   },

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.7"
+version = "0.3.8"
 documentation = "https://docs.rs/kittycad"
 readme = "README.md"
 repository = "https://github.com/KittyCAD/kittycad.rs/tree/main/kittycad"
@@ -10,11 +10,11 @@ license = "MIT"
 
 [dependencies]
 anyhow = "1"
-async-trait = { version = "^0.1.81", optional = true }
+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.9", 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 }
@@ -25,7 +25,7 @@ itertools = "0.13.0"
 log = { version = "^0.4", features = ["serde"], optional = true }
 mime_guess = "2.0.4"
 parse-display = "0.9.1"
-phonenumber = "0.3.6"
+phonenumber = "0.3.5"
 rand = { version = "0.8", optional = true }
 reqwest = { version = "0.11.27", default-features = false, features = ["json", "multipart", "rustls-tls"], optional = true }
 reqwest-conditional-middleware = { version = "0.2.1", 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.7"
+kittycad = "0.3.8"
 ```
 
 ## Basic example

diff --git a/kittycad/src/api_calls.rs b/kittycad/src/api_calls.rs
@@ -323,24 +323,25 @@ impl ApiCalls {
              endpoint requires authentication by any Zoo user. It returns details of the requested \
              async operation for the user.\nIf the user is not authenticated to view the specified \
              async operation, then it is not returned.\nOnly Zoo employees with the proper access \
-             can view async operations for other users.\n\n**Parameters:**\n\n- `id: &'astr`: The \
-             ID of the async operation. (required)\n\n```rust,no_run\nasync fn \
-             example_api_calls_get_async_operation() -> anyhow::Result<()> {\n    let client = \
-             kittycad::Client::new_from_env();\n    let result: \
-             kittycad::types::AsyncApiCallOutput = client\n        .api_calls()\n        \
-             .get_async_operation(\"some-string\")\n        .await?;\n    println!(\"{:?}\", \
-             result);\n    Ok(())\n}\n```"]
+             can view async operations for other users.\n\n**Parameters:**\n\n- `id: uuid::Uuid`: \
+             The ID of the async operation. (required)\n\n```rust,no_run\nuse \
+             std::str::FromStr;\nasync fn example_api_calls_get_async_operation() -> \
+             anyhow::Result<()> {\n    let client = kittycad::Client::new_from_env();\n    let \
+             result: kittycad::types::AsyncApiCallOutput = client\n        .api_calls()\n        \
+             .get_async_operation(uuid::Uuid::from_str(\n            \
+             \"d9797f8d-9ad6-4e08-90d7-2ec17e13471c\",\n        )?)\n        .await?;\n    \
+             println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
     #[tracing::instrument]
     pub async fn get_async_operation<'a>(
         &'a self,
-        id: &'a str,
+        id: uuid::Uuid,
     ) -> Result<crate::types::AsyncApiCallOutput, crate::types::error::Error> {
         let mut req = self.client.client.request(
             http::Method::GET,
             format!(
                 "{}/{}",
                 self.client.base_url,
-                "async/operations/{id}".replace("{id}", id)
+                "async/operations/{id}".replace("{id}", &format!("{}", id))
             ),
         );
         req = req.bearer_auth(&self.client.token);

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

diff --git a/kittycad/src/tests.rs b/kittycad/src/tests.rs
@@ -1,3 +1,5 @@
+use std::str::FromStr;
+
 #[cfg(not(feature = "js"))]
 use futures::TryStreamExt;
 use pretty_assertions::assert_eq;
@@ -84,7 +86,7 @@ async fn test_get_status_of_async_operation() {
 
     let _result = client
         .api_calls()
-        .get_async_operation("23a9759f-ee9b-47de-9a55-deb1ed035793")
+        .get_async_operation(uuid::Uuid::from_str("23a9759f-ee9b-47de-9a55-deb1ed035793").unwrap())
         .await
         .unwrap();
 }
@@ -95,7 +97,7 @@ async fn serialize_one_of() {
 
     let result = client
         .api_calls()
-        .get_async_operation("23a9759f-ee9b-47de-9a55-deb1ed035793")
+        .get_async_operation(uuid::Uuid::from_str("23a9759f-ee9b-47de-9a55-deb1ed035793").unwrap())
         .await
         .unwrap();
 
@@ -112,7 +114,7 @@ async fn tabled_one_of() {
 
     let result = client
         .api_calls()
-        .get_async_operation("23a9759f-ee9b-47de-9a55-deb1ed035793")
+        .get_async_operation(uuid::Uuid::from_str("23a9759f-ee9b-47de-9a55-deb1ed035793").unwrap())
         .await
         .unwrap();
 

diff --git a/spec.json b/spec.json
@@ -1249,7 +1249,8 @@
             "description": "The ID of the async operation.",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "format": "uuid"
             }
           }
         ],