Skip to content

Commit 6f3f4d8

Browse files
Update api spec (#179)
* YOYO NEW API SPEC! * I have generated the latest API! --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 7946110 commit 6f3f4d8

File tree

2 files changed

+174
-75
lines changed

2 files changed

+174
-75
lines changed

spec.json

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16368,6 +16368,11 @@
1636816368
}
1636916369
]
1637016370
},
16371+
"kcl_version": {
16372+
"nullable": true,
16373+
"description": "The version of kcl requested.",
16374+
"type": "string"
16375+
},
1637116376
"model": {
1637216377
"description": "The model being used.",
1637316378
"allOf": [
@@ -25324,6 +25329,38 @@
2532425329
"type"
2532525330
]
2532625331
},
25332+
{
25333+
"description": "Looks along the normal of the specified face (if it is planar!), and fits the view to it.",
25334+
"type": "object",
25335+
"properties": {
25336+
"animated": {
25337+
"description": "Whether or not to animate the camera movement. (Animation is currently not supported.)",
25338+
"default": false,
25339+
"type": "boolean"
25340+
},
25341+
"face_id": {
25342+
"description": "Which face to orient camera to. If the face is not planar, no action will occur.",
25343+
"type": "string",
25344+
"format": "uuid"
25345+
},
25346+
"padding": {
25347+
"description": "How much to pad the view frame by, as a fraction of the face bounding box size. Negative padding will crop the view of the face proportionally. e.g. padding = 0.2 means the view will span 120% of the face bounding box, and padding = -0.2 means the view will span 80% of the face bounding box.",
25348+
"default": 0.0,
25349+
"type": "number",
25350+
"format": "float"
25351+
},
25352+
"type": {
25353+
"type": "string",
25354+
"enum": [
25355+
"orient_to_face"
25356+
]
25357+
}
25358+
},
25359+
"required": [
25360+
"face_id",
25361+
"type"
25362+
]
25363+
},
2532725364
{
2532825365
"description": "Fit the view to the scene with an isometric view.",
2532925366
"type": "object",
@@ -26899,6 +26936,24 @@
2689926936
"type"
2690026937
]
2690126938
},
26939+
{
26940+
"type": "object",
26941+
"properties": {
26942+
"data": {
26943+
"$ref": "#/components/schemas/OrientToFace"
26944+
},
26945+
"type": {
26946+
"type": "string",
26947+
"enum": [
26948+
"orient_to_face"
26949+
]
26950+
}
26951+
},
26952+
"required": [
26953+
"data",
26954+
"type"
26955+
]
26956+
},
2690226957
{
2690326958
"type": "object",
2690426959
"properties": {
@@ -28398,6 +28453,23 @@
2839828453
}
2839928454
]
2840028455
},
28456+
"OrientToFace": {
28457+
"description": "The response from the `OrientToFace` command.",
28458+
"type": "object",
28459+
"properties": {
28460+
"settings": {
28461+
"description": "Camera settings",
28462+
"allOf": [
28463+
{
28464+
"$ref": "#/components/schemas/CameraSettings"
28465+
}
28466+
]
28467+
}
28468+
},
28469+
"required": [
28470+
"settings"
28471+
]
28472+
},
2840128473
"OriginType": {
2840228474
"description": "The type of origin",
2840328475
"oneOf": [
@@ -30737,6 +30809,11 @@
3073730809
}
3073830810
]
3073930811
},
30812+
"kcl_version": {
30813+
"nullable": true,
30814+
"description": "The version of kcl requested.",
30815+
"type": "string"
30816+
},
3074030817
"model": {
3074130818
"description": "The model being used.",
3074230819
"allOf": [

0 commit comments

Comments
 (0)