Update api spec (#391)

* YOYO NEW API SPEC! * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jess Frazelle <github@jessfraz.com>
2025-03-11 18:36:30 -07:00
parent 0ff7b17ce8
commit ca39f6266a
20 changed files with 1704 additions and 987 deletions
--- a/kittycad/models/output_format3d.py
+++ b/kittycad/models/output_format3d.py
@ -0,0 +1,104 @@
+from typing import Literal, Union
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel
+from typing_extensions import Annotated
+
+from ..models.fbx_storage import FbxStorage
+from ..models.gltf_presentation import GltfPresentation
+from ..models.gltf_storage import GltfStorage
+from ..models.ply_storage import PlyStorage
+from ..models.selection import Selection
+from ..models.stl_storage import StlStorage
+from ..models.system import System
+from ..models.unit_length import UnitLength
+
+
+class OptionFbx(BaseModel):
+    """Autodesk Filmbox (FBX) format."""
+
+    storage: FbxStorage
+
+    type: Literal["fbx"] = "fbx"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionGltf(BaseModel):
+    """glTF 2.0. We refer to this as glTF since that is how our customers refer to it, although by default it will be in binary format and thus technically (glb). If you prefer ASCII output, you can set that option for the export."""
+
+    presentation: GltfPresentation
+
+    storage: GltfStorage
+
+    type: Literal["gltf"] = "gltf"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionObj(BaseModel):
+    """Wavefront OBJ format."""
+
+    coords: System
+
+    type: Literal["obj"] = "obj"
+
+    units: UnitLength
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionPly(BaseModel):
+    """The PLY Polygon File Format."""
+
+    coords: System
+
+    selection: Selection
+
+    storage: PlyStorage
+
+    type: Literal["ply"] = "ply"
+
+    units: UnitLength
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionStep(BaseModel):
+    """ISO 10303-21 (STEP) format."""
+
+    coords: System
+
+    type: Literal["step"] = "step"
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+class OptionStl(BaseModel):
+    """*ST**ereo**L**ithography format."""
+
+    coords: System
+
+    selection: Selection
+
+    storage: StlStorage
+
+    type: Literal["stl"] = "stl"
+
+    units: UnitLength
+
+    model_config = ConfigDict(protected_namespaces=())
+
+
+OutputFormat3d = RootModel[
+    Annotated[
+        Union[
+            OptionFbx,
+            OptionGltf,
+            OptionObj,
+            OptionPly,
+            OptionStep,
+            OptionStl,
+        ],
+        Field(discriminator="type"),
+    ]
+]