Skip to content

Update api spec #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jessfraz merged 3 commits into from
Jan 27, 2025
Merged

Update api spec #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82c31d0
YOYO NEW API SPEC!
github-actions[bot] Jan 27, 2025
44d3777
Generated new lib
github-actions[bot] Jan 27, 2025
9cdcba6
2.0.14
github-actions[bot] Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kittycad/lib",
"version": "2.0.13",
"version": "2.0.14",
"description": "Javascript library for KittyCAD API",
"type": "module",
"keywords": [
Expand Down
216 changes: 191 additions & 25 deletions spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1279,7 +1279,7 @@
"tags": [
"hidden"
],
"summary": "Listen for callbacks for email verification for users.",
"summary": "Listen for callbacks for email authentication for users.",
"operationId": "auth_email_callback",
"parameters": [
{
Expand Down Expand Up @@ -17100,6 +17100,48 @@
"r"
]
},
"ComponentTransform": {
"description": "Container that holds a translate, rotate and scale.",
"type": "object",
"properties": {
"rotate_angle_axis": {
"nullable": true,
"description": "Rotate component of the transform. The rotation is specified as an axis and an angle (xyz are the components of the axis, w is the angle in degrees).",
"allOf": [
{
"$ref": "#/components/schemas/TransformByForPoint4d"
}
]
},
"rotate_rpy": {
"nullable": true,
"description": "Rotate component of the transform. The rotation is specified as a roll, pitch, yaw.",
"allOf": [
{
"$ref": "#/components/schemas/TransformByForPoint3d"
}
]
},
"scale": {
"nullable": true,
"description": "Scale component of the transform.",
"allOf": [
{
"$ref": "#/components/schemas/TransformByForPoint3d"
}
]
},
"translate": {
"nullable": true,
"description": "Translate component of the transform.",
"allOf": [
{
"$ref": "#/components/schemas/TransformByForPoint3d"
}
]
}
}
},
"Connection": {
"description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.",
"type": "object",
Expand Down Expand Up @@ -18351,31 +18393,15 @@
},
"EntityMakeHelix": {
"description": "The response from the `EntityMakeHelix` endpoint.",
"type": "object",
"properties": {
"helix_id": {
"description": "The UUID of the helix that was created.",
"type": "string",
"format": "uuid"
}
},
"required": [
"helix_id"
]
"type": "object"
},
"EntityMakeHelixFromEdge": {
"description": "The response from the `EntityMakeHelixFromEdge` endpoint.",
"type": "object"
},
"EntityMakeHelixFromParams": {
"description": "The response from the `EntityMakeHelixFromParams` endpoint.",
"type": "object",
"properties": {
"helix_id": {
"description": "The UUID of the helix that was created.",
"type": "string",
"format": "uuid"
}
},
"required": [
"helix_id"
]
"type": "object"
},
"EntityMirror": {
"description": "The response from the `EntityMirror` endpoint.",
Expand Down Expand Up @@ -22694,8 +22720,11 @@
},
"radius": {
"description": "Radius of the helix.",
"type": "number",
"format": "double"
"allOf": [
{
"$ref": "#/components/schemas/LengthUnit"
}
]
},
"revolutions": {
"description": "Number of revolutions.",
Expand Down Expand Up @@ -22731,6 +22760,68 @@
"type"
]
},
{
"description": "Create a helix using the specified parameters.",
"type": "object",
"properties": {
"edge_id": {
"description": "Edge about which to make the helix.",
"type": "string",
"format": "uuid"
},
"is_clockwise": {
"description": "Is the helix rotation clockwise?",
"type": "boolean"
},
"length": {
"nullable": true,
"description": "Length of the helix. If None, the length of the edge will be used instead.",
"allOf": [
{
"$ref": "#/components/schemas/LengthUnit"
}
]
},
"radius": {
"description": "Radius of the helix.",
"allOf": [
{
"$ref": "#/components/schemas/LengthUnit"
}
]
},
"revolutions": {
"description": "Number of revolutions.",
"type": "number",
"format": "double"
},
"start_angle": {
"description": "Start angle.",
"default": {
"unit": "degrees",
"value": 0.0
},
"allOf": [
{
"$ref": "#/components/schemas/Angle"
}
]
},
"type": {
"type": "string",
"enum": [
"entity_make_helix_from_edge"
]
}
},
"required": [
"edge_id",
"is_clockwise",
"radius",
"revolutions",
"type"
]
},
{
"description": "Mirror the input entities over the specified axis. (Currently only supports sketches)",
"type": "object",
Expand Down Expand Up @@ -24980,6 +25071,35 @@
"type"
]
},
{
"description": "Set the transform of an object.",
"type": "object",
"properties": {
"object_id": {
"description": "Id of the object whose transform is to be set.",
"type": "string",
"format": "uuid"
},
"transforms": {
"description": "List of transforms to be applied to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentTransform"
}
},
"type": {
"type": "string",
"enum": [
"set_object_transform"
]
}
},
"required": [
"object_id",
"transforms",
"type"
]
},
{
"description": "Make a new path by offsetting an object by a given distance. The new path's ID will be the ID of this command.",
"type": "object",
Expand Down Expand Up @@ -26487,6 +26607,24 @@
"type"
]
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SetObjectTransform"
},
"type": {
"type": "string",
"enum": [
"set_object_transform"
]
}
},
"required": [
"data",
"type"
]
},
{
"type": "object",
"properties": {
Expand Down Expand Up @@ -27243,6 +27381,24 @@
"type"
]
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityMakeHelixFromEdge"
},
"type": {
"type": "string",
"enum": [
"entity_make_helix_from_edge"
]
}
},
"required": [
"data",
"type"
]
},
{
"type": "object",
"properties": {
Expand Down Expand Up @@ -29470,6 +29626,10 @@
"description": "The response from the `SetDefaultSystemProperties` endpoint.",
"type": "object"
},
"SetObjectTransform": {
"description": "The response from the `SetObjectTransform` command.",
"type": "object"
},
"SetSceneUnits": {
"description": "The response from the `SetSceneUnits` endpoint.",
"type": "object"
Expand Down Expand Up @@ -30520,6 +30680,12 @@
}
}
},
"TransformByForPoint3d": {
"type": "string"
},
"TransformByForPoint4d": {
"type": "string"
},
"UnitAngle": {
"description": "The valid types of angle formats.",
"oneOf": [
Expand Down
Loading