YOYO NEW API SPEC!

KittyCAD · Oct 30, 2024 · aa79159 · aa79159
1 parent c8a44c1
commit aa79159
Showing 1 changed file with 119 additions and 0 deletions.
diff --git a/spec.json b/spec.json
@@ -16646,6 +16646,25 @@
         "description": "The response from the `CameraDragStart` endpoint.",
         "type": "object"
       },
+      "CameraMovement": {
+        "description": "A type of camera movement applied after certain camera operations",
+        "oneOf": [
+          {
+            "description": "Adjusts the camera position during the camera operation",
+            "type": "string",
+            "enum": [
+              "vantage"
+            ]
+          },
+          {
+            "description": "Keeps the camera position in place",
+            "type": "string",
+            "enum": [
+              "none"
+            ]
+          }
+        ]
+      },
       "CameraSettings": {
         "description": "Camera settings including position, center, fov etc",
         "type": "object",
@@ -17677,6 +17696,10 @@
           }
         ]
       },
+      "DefaultCameraCenterToScene": {
+        "description": "The response from the `DefaultCameraCenterToScene` endpoint.",
+        "type": "object"
+      },
       "DefaultCameraCenterToSelection": {
         "description": "The response from the `DefaultCameraCenterToSelection` endpoint.",
         "type": "object"
@@ -24039,6 +24062,13 @@
             "description": "Reconfigure the stream.",
             "type": "object",
             "properties": {
+              "bitrate": {
+                "nullable": true,
+                "description": "Video feed's constant bitrate (CBR)",
+                "type": "integer",
+                "format": "uint32",
+                "minimum": 0
+              },
               "fps": {
                 "description": "Frames per second.",
                 "type": "integer",
@@ -24433,6 +24463,15 @@
             "description": "Updates the camera to center to the center of the current selection (or the origin if nothing is selected)",
             "type": "object",
             "properties": {
+              "camera_movement": {
+                "description": "Dictates whether or not the camera position should be adjusted during this operation If no movement is requested, the camera will orbit around the new center from its current position",
+                "default": "vantage",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/CameraMovement"
+                  }
+                ]
+              },
               "type": {
                 "type": "string",
                 "enum": [
@@ -24444,6 +24483,30 @@
               "type"
             ]
           },
+          {
+            "description": "Updates the camera to center to the center of the current scene's bounds",
+            "type": "object",
+            "properties": {
+              "camera_movement": {
+                "description": "Dictates whether or not the camera position should be adjusted during this operation If no movement is requested, the camera will orbit around the new center from its current position",
+                "default": "vantage",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/CameraMovement"
+                  }
+                ]
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "default_camera_center_to_scene"
+                ]
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
           {
             "description": "Fit the view to the specified object(s).",
             "type": "object",
@@ -25689,6 +25752,24 @@
               "type"
             ]
           },
+          {
+            "type": "object",
+            "properties": {
+              "data": {
+                "$ref": "#/components/schemas/DefaultCameraCenterToScene"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "default_camera_center_to_scene"
+                ]
+              }
+            },
+            "required": [
+              "data",
+              "type"
+            ]
+          },
           {
             "type": "object",
             "properties": {
@@ -27900,6 +27981,44 @@
               "to",
               "type"
             ]
+          },
+          {
+            "description": "Adds an arc from the current position that goes through the given interior point and ends at the given end position",
+            "type": "object",
+            "properties": {
+              "end": {
+                "description": "End point of the arc.",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Point3d"
+                  }
+                ]
+              },
+              "interior": {
+                "description": "Interior point of the arc.",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Point3d"
+                  }
+                ]
+              },
+              "relative": {
+                "description": "Whether or not interior and end are relative to the previous path position",
+                "type": "boolean"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "arc_to"
+                ]
+              }
+            },
+            "required": [
+              "end",
+              "interior",
+              "relative",
+              "type"
+            ]
           }
         ]
       },