Skip to content
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.

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

Update api spec #267

Merged
merged 3 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kittycad/lib",
"version": "2.0.1",
"version": "2.0.2",
"description": "Javascript library for KittyCAD API",
"type": "module",
"keywords": [
Expand Down
13 changes: 7 additions & 6 deletions spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -20480,7 +20480,7 @@
]
},
{
"description": "Move the path's \"pen\".",
"description": "Move the path's \"pen\". If you're in sketch mode, these coordinates are in the local coordinate system, not the world's coordinate system. For example, say you're sketching on the plane {x: (1,0,0), y: (0,1,0), origin: (0, 0, 50)}. In other words, the plane 50 units above the default XY plane. Then, moving the pen to (1, 1, 0) with this command uses local coordinates. So, it would move the pen to (1, 1, 50) in global coordinates.",
"type": "object",
"properties": {
"path": {
Expand Down Expand Up @@ -20549,10 +20549,6 @@
"description": "Command for extruding a solid 2d.",
"type": "object",
"properties": {
"cap": {
"description": "Whether to cap the extrusion with a face, or not. If true, the resulting solid will be closed on all sides, like a dice. If false, it will be open on one side, like a drinking glass.",
"type": "boolean"
},
"distance": {
"description": "How far off the plane to extrude",
"allOf": [
Expand All @@ -20577,7 +20573,6 @@
}
},
"required": [
"cap",
"distance",
"target",
"type"
Expand Down Expand Up @@ -22113,6 +22108,12 @@
"type": "string",
"format": "uuid"
},
"face_id": {
"nullable": true,
"description": "The ID to use for the newly created fillet face. If not provided, the server will randomly generate one.",
"type": "string",
"format": "uuid"
},
"object_id": {
"description": "Which object is being filletted.",
"type": "string",
Expand Down
7 changes: 6 additions & 1 deletion src/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2166,7 +2166,6 @@ export type ModelingCmd_type =
type: 'extend_path';
}
| {
cap: boolean /* Whether to cap the extrusion with a face, or not. If true, the resulting solid will be closed on all sides, like a dice. If false, it will be open on one side, like a drinking glass. */;
distance: LengthUnit_type /* How far off the plane to extrude */;
target: ModelingCmdId_type /* Which sketch to extrude. Must be a closed 2D solid. */;
type: 'extrude';
Expand Down Expand Up @@ -2568,6 +2567,12 @@ export type ModelingCmd_type =
cut_type: CutType_type;
/* format:uuid, description:Which edge you want to fillet. */
edge_id: string;
/*{
"nullable": true,
"format": "uuid",
"description": "The ID to use for the newly created fillet face. If not provided, the server will randomly generate one."
}*/
face_id?: string;
/* format:uuid, description:Which object is being filletted. */
object_id: string;
radius: LengthUnit_type /* The radius of the fillet. Measured in length (using the same units that the current sketch uses). Must be positive (i.e. greater than zero). */;
Expand Down