Skip to content

Commit 808270f

Browse files
Update api spec (#323)
* YOYO NEW API SPEC! * Generated new lib * 2.0.33 --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent dabf6ca commit 808270f

File tree

4 files changed

+66
-16
lines changed

4 files changed

+66
-16
lines changed

kittycad.ts.patch.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"op": "add",
44
"path": "/paths/~1ws~1modeling~1commands/get/x-typescript",
55
"value": {
6-
"example": "import { modeling } from '@kittycad/lib'\n\nasync function example() {\n const response = await modeling.modeling_commands_ws({\n fps: 7,\n pool: 'string',\n post_effect: 'ssao',\n replay: 'string',\n show_grid: true,\n unlocked_framerate: true,\n video_res_height: 7,\n video_res_width: 7,\n webrtc: true,\n body: {\n candidate: {\n candidate: 'The candidate string associated with the object.',\n sdpMLineIndex: 7,\n sdpMid: \"The identifier of the 'media stream identification' as defined in [RFC 8841](https://tools.ietf.org/html/rfc8841).\",\n usernameFragment:\n 'The username fragment (as defined in [RFC 8445](https://tools.ietf.org/html/rfc8445#section-5.2.1)) associated with the object.',\n },\n type: 'trickle_ice',\n },\n })\n if ('error_code' in response) throw response\n console.log(JSON.stringify(response, null, 2))\n}\n",
6+
"example": "import { modeling } from '@kittycad/lib'\n\nasync function example() {\n const response = await modeling.modeling_commands_ws({\n api_call_id: 'string',\n fps: 7,\n pool: 'string',\n post_effect: 'ssao',\n replay: 'string',\n show_grid: true,\n unlocked_framerate: true,\n video_res_height: 7,\n video_res_width: 7,\n webrtc: true,\n body: {\n candidate: {\n candidate: 'The candidate string associated with the object.',\n sdpMLineIndex: 7,\n sdpMid: \"The identifier of the 'media stream identification' as defined in [RFC 8841](https://tools.ietf.org/html/rfc8841).\",\n usernameFragment:\n 'The username fragment (as defined in [RFC 8445](https://tools.ietf.org/html/rfc8445#section-5.2.1)) associated with the object.',\n },\n type: 'trickle_ice',\n },\n })\n if ('error_code' in response) throw response\n console.log(JSON.stringify(response, null, 2))\n}\n",
77
"libDocsLink": ""
88
}
99
},

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@kittycad/lib",
3-
"version": "2.0.32",
3+
"version": "2.0.33",
44
"description": "Javascript library for KittyCAD API",
55
"type": "module",
66
"keywords": [

spec.json

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16427,6 +16427,15 @@
1642716427
"description": "Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.",
1642816428
"operationId": "modeling_commands_ws",
1642916429
"parameters": [
16430+
{
16431+
"in": "query",
16432+
"name": "api_call_id",
16433+
"description": "API Call ID for distributed tracing",
16434+
"schema": {
16435+
"nullable": true,
16436+
"type": "string"
16437+
}
16438+
},
1643016439
{
1643116440
"in": "query",
1643216441
"name": "fps",
@@ -18646,10 +18655,7 @@
1864618655
"format": "uuid"
1864718656
}
1864818657
}
18649-
},
18650-
"required": [
18651-
"extra_solid_ids"
18652-
]
18658+
}
1865318659
},
1865418660
"BooleanSubtract": {
1865518661
"description": "The response from the 'BooleanSubtract'.",
@@ -18663,10 +18669,7 @@
1866318669
"format": "uuid"
1866418670
}
1866518671
}
18666-
},
18667-
"required": [
18668-
"extra_solid_ids"
18669-
]
18672+
}
1867018673
},
1867118674
"BooleanUnion": {
1867218675
"description": "The response from the 'BooleanUnion'.",
@@ -18680,10 +18683,7 @@
1868018683
"format": "uuid"
1868118684
}
1868218685
}
18683-
},
18684-
"required": [
18685-
"extra_solid_ids"
18686-
]
18686+
}
1868718687
},
1868818688
"CacheMetadata": {
1868918689
"description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.",
@@ -19209,7 +19209,7 @@
1920919209
]
1921019210
},
1921119211
"ComponentTransform": {
19212-
"description": "Container that holds a translate, rotate and scale.",
19212+
"description": "Container that holds a translate, rotate and scale. Defaults to no change, everything stays the same (i.e. the identity function).",
1921319213
"type": "object",
1921419214
"properties": {
1921519215
"rotate_angle_axis": {
@@ -30525,6 +30525,34 @@
3052530525
"data",
3052630526
"type"
3052730527
]
30528+
},
30529+
{
30530+
"description": "Information about the connected instance",
30531+
"type": "object",
30532+
"properties": {
30533+
"data": {
30534+
"type": "object",
30535+
"properties": {
30536+
"name": {
30537+
"description": "Instance name. This may or may not mean something.",
30538+
"type": "string"
30539+
}
30540+
},
30541+
"required": [
30542+
"name"
30543+
]
30544+
},
30545+
"type": {
30546+
"type": "string",
30547+
"enum": [
30548+
"debug"
30549+
]
30550+
}
30551+
},
30552+
"required": [
30553+
"data",
30554+
"type"
30555+
]
3052830556
}
3052930557
]
3053030558
},
@@ -36313,6 +36341,21 @@
3631336341
"type"
3631436342
]
3631536343
},
36344+
{
36345+
"description": "Return information about the connected instance",
36346+
"type": "object",
36347+
"properties": {
36348+
"type": {
36349+
"type": "string",
36350+
"enum": [
36351+
"debug"
36352+
]
36353+
}
36354+
},
36355+
"required": [
36356+
"type"
36357+
]
36358+
},
3631636359
{
3631736360
"description": "Authentication header request.",
3631836361
"type": "object",

src/models.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4506,7 +4506,13 @@ export type OkWebSocketResponseData_type =
45064506
};
45074507
type: 'modeling_session_data';
45084508
}
4509-
| { data: object; type: 'pong' };
4509+
| { data: object; type: 'pong' }
4510+
| {
4511+
data: {
4512+
name: string /* Instance name. This may or may not mean something. */;
4513+
};
4514+
type: 'debug';
4515+
};
45104516

45114517
export interface Onboarding_type {
45124518
/*{
@@ -6409,6 +6415,7 @@ export type WebSocketRequest_type =
64096415
metrics: ClientMetrics_type /* Collected metrics from the Client's end of the engine connection. */;
64106416
type: 'metrics_response';
64116417
}
6418+
| { type: 'debug' }
64126419
| { headers: { [key: string]: string }; type: 'headers' };
64136420

64146421
export type WebSocketResponse_type =

0 commit comments

Comments
 (0)