Skip to content

Commit 6fc5a7d

Browse files
zoo-github-actions-auth[bot]github-actions[bot]jessfraz
authored
Update api spec (#134)
* YOYO NEW API SPEC! * updates Signed-off-by: Jess Frazelle <[email protected]> --------- Signed-off-by: Jess Frazelle <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jess Frazelle <[email protected]>
1 parent 5136233 commit 6fc5a7d

File tree

4 files changed

+533
-526
lines changed

4 files changed

+533
-526
lines changed

‎go.mod

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ require (
2323
github.com/perimeterx/marshmallow v1.1.4 // indirect
2424
go4.org/intern v0.0.0-20211027215823-ae77deb06f29 // indirect
2525
go4.org/unsafe/assume-no-moving-gc v0.0.0-20220617031537-928513b29760 // indirect
26-
golang.org/x/net v0.24.0 // indirect
27-
golang.org/x/sys v0.19.0 // indirect
26+
golang.org/x/net v0.25.0 // indirect
27+
golang.org/x/sys v0.20.0 // indirect
2828
gopkg.in/yaml.v2 v2.4.0 // indirect
2929
gopkg.in/yaml.v3 v3.0.1 // indirect
3030
)

‎go.sum

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,17 @@ golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
6868
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
6969
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
7070
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
71-
golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w=
72-
golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
71+
golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
72+
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
7373
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
7474
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
7575
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
7676
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
7777
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
7878
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
7979
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
80-
golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
81-
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
80+
golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
81+
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
8282
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
8383
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
8484
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

‎spec.json

Lines changed: 141 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -14431,6 +14431,14 @@
1443114431
"type": "number",
1443214432
"format": "float"
1443314433
},
14434+
"orientation": {
14435+
"description": "The Camera's orientation (in the form of a quaternion)",
14436+
"allOf": [
14437+
{
14438+
"$ref": "#/components/schemas/Point4d"
14439+
}
14440+
]
14441+
},
1443414442
"ortho": {
1443514443
"description": "Whether or not the camera is in ortho mode",
1443614444
"type": "boolean"
@@ -14460,6 +14468,7 @@
1446014468
},
1446114469
"required": [
1446214470
"center",
14471+
"orientation",
1446314472
"ortho",
1446414473
"pos",
1446514474
"up"
@@ -15825,6 +15834,20 @@
1582515834
"bad_request"
1582615835
]
1582715836
},
15837+
{
15838+
"description": "Auth token is missing from the request",
15839+
"type": "string",
15840+
"enum": [
15841+
"auth_token_missing"
15842+
]
15843+
},
15844+
{
15845+
"description": "Auth token is invalid in some way (expired, incorrect format, etc)",
15846+
"type": "string",
15847+
"enum": [
15848+
"auth_token_invalid"
15849+
]
15850+
},
1582815851
{
1582915852
"description": "Client sent invalid JSON.",
1583015853
"type": "string",
@@ -16163,6 +16186,23 @@
1616316186
"cap"
1616416187
]
1616516188
},
16189+
"FaceGetCenter": {
16190+
"description": "The 3D center of mass on the surface",
16191+
"type": "object",
16192+
"properties": {
16193+
"pos": {
16194+
"description": "The 3D position on the surface center of mass",
16195+
"allOf": [
16196+
{
16197+
"$ref": "#/components/schemas/Point3d"
16198+
}
16199+
]
16200+
}
16201+
},
16202+
"required": [
16203+
"pos"
16204+
]
16205+
},
1616616206
"FaceGetGradient": {
1616716207
"description": "The gradient (dFdu, dFdv) + normal vector on a brep face",
1616816208
"type": "object",
@@ -19048,79 +19088,6 @@
1904819088
"type"
1904919089
]
1905019090
},
19051-
{
19052-
"description": "Enable sketch mode, where users can sketch 2D geometry. Users choose a plane to sketch on.",
19053-
"type": "object",
19054-
"properties": {
19055-
"animated": {
19056-
"description": "Should we animate or snap for the camera transition?",
19057-
"type": "boolean"
19058-
},
19059-
"distance_to_plane": {
19060-
"description": "How far to the sketching plane?",
19061-
"type": "number",
19062-
"format": "float"
19063-
},
19064-
"origin": {
19065-
"description": "What's the origin of the sketching plane?",
19066-
"allOf": [
19067-
{
19068-
"$ref": "#/components/schemas/Point3d"
19069-
}
19070-
]
19071-
},
19072-
"ortho": {
19073-
"description": "Should the camera use orthographic projection? In other words, should an object's size in the rendered image stay constant regardless of its distance from the camera.",
19074-
"type": "boolean"
19075-
},
19076-
"type": {
19077-
"type": "string",
19078-
"enum": [
19079-
"default_camera_enable_sketch_mode"
19080-
]
19081-
},
19082-
"x_axis": {
19083-
"description": "Which 3D axis of the scene should be the X axis of the sketching plane?",
19084-
"allOf": [
19085-
{
19086-
"$ref": "#/components/schemas/Point3d"
19087-
}
19088-
]
19089-
},
19090-
"y_axis": {
19091-
"description": "Which 3D axis of the scene should be the Y axis of the sketching plane?",
19092-
"allOf": [
19093-
{
19094-
"$ref": "#/components/schemas/Point3d"
19095-
}
19096-
]
19097-
}
19098-
},
19099-
"required": [
19100-
"animated",
19101-
"distance_to_plane",
19102-
"origin",
19103-
"ortho",
19104-
"type",
19105-
"x_axis",
19106-
"y_axis"
19107-
]
19108-
},
19109-
{
19110-
"description": "Disable sketch mode, from the default camera.",
19111-
"type": "object",
19112-
"properties": {
19113-
"type": {
19114-
"type": "string",
19115-
"enum": [
19116-
"default_camera_disable_sketch_mode"
19117-
]
19118-
}
19119-
},
19120-
"required": [
19121-
"type"
19122-
]
19123-
},
1912419091
{
1912519092
"description": "Export the scene to a file.",
1912619093
"type": "object",
@@ -20161,6 +20128,27 @@
2016120128
"uv"
2016220129
]
2016320130
},
20131+
{
20132+
"description": "Obtains the surface \"center of mass\"",
20133+
"type": "object",
20134+
"properties": {
20135+
"object_id": {
20136+
"description": "Which face is being queried.",
20137+
"type": "string",
20138+
"format": "uuid"
20139+
},
20140+
"type": {
20141+
"type": "string",
20142+
"enum": [
20143+
"face_get_center"
20144+
]
20145+
}
20146+
},
20147+
"required": [
20148+
"object_id",
20149+
"type"
20150+
]
20151+
},
2016420152
{
2016520153
"description": "Determines the gradient (dFdu, dFdv) + normal vector on a brep face evaluated by parameters u,v",
2016620154
"type": "object",
@@ -20446,46 +20434,6 @@
2044620434
"window"
2044720435
]
2044820436
},
20449-
{
20450-
"description": "Enable sketch mode on the given plane. If you want to sketch on a face, use `enable_sketch_mode` instead.",
20451-
"type": "object",
20452-
"properties": {
20453-
"animated": {
20454-
"description": "Animate the transition to sketch mode.",
20455-
"type": "boolean"
20456-
},
20457-
"disable_camera_with_plane": {
20458-
"nullable": true,
20459-
"description": "Disable the camera entirely for sketch mode and sketch on a plane (this would be the normal of that plane).",
20460-
"allOf": [
20461-
{
20462-
"$ref": "#/components/schemas/Point3d"
20463-
}
20464-
]
20465-
},
20466-
"ortho": {
20467-
"description": "Use an orthographic camera.",
20468-
"type": "boolean"
20469-
},
20470-
"plane_id": {
20471-
"description": "Sketch on this plane.",
20472-
"type": "string",
20473-
"format": "uuid"
20474-
},
20475-
"type": {
20476-
"type": "string",
20477-
"enum": [
20478-
"sketch_mode_enable"
20479-
]
20480-
}
20481-
},
20482-
"required": [
20483-
"animated",
20484-
"ortho",
20485-
"plane_id",
20486-
"type"
20487-
]
20488-
},
2048920437
{
2049020438
"description": "Disable sketch mode. If you are sketching on a face, be sure to not disable sketch mode until you have extruded. Otherwise, your object will not be fused with the face.",
2049120439
"type": "object",
@@ -20576,6 +20524,15 @@
2057620524
"description": "Should the camera use orthographic projection? In other words, should an object's size in the rendered image stay constant regardless of its distance from the camera.",
2057720525
"type": "boolean"
2057820526
},
20527+
"planar_normal": {
20528+
"nullable": true,
20529+
"description": "If provided, ensures that the normal of the sketch plane must be aligned with this supplied normal (otherwise the camera position will be used to infer the normal to point towards the viewer)",
20530+
"allOf": [
20531+
{
20532+
"$ref": "#/components/schemas/Point3d"
20533+
}
20534+
]
20535+
},
2057920536
"type": {
2058020537
"type": "string",
2058120538
"enum": [
@@ -21405,6 +21362,27 @@
2140521362
"type"
2140621363
]
2140721364
},
21365+
{
21366+
"description": "Fit the view to the scene with an isometric view.",
21367+
"type": "object",
21368+
"properties": {
21369+
"padding": {
21370+
"description": "How much to pad the view frame by.",
21371+
"default": 0.0,
21372+
"type": "number",
21373+
"format": "float"
21374+
},
21375+
"type": {
21376+
"type": "string",
21377+
"enum": [
21378+
"view_isometric"
21379+
]
21380+
}
21381+
},
21382+
"required": [
21383+
"type"
21384+
]
21385+
},
2140821386
{
2140921387
"description": "Get a concise description of all of an extrusion's faces.",
2141021388
"type": "object",
@@ -22189,6 +22167,25 @@
2218922167
"type"
2219022168
]
2219122169
},
22170+
{
22171+
"description": "The response to the 'FaceGetCenter' endpoint",
22172+
"type": "object",
22173+
"properties": {
22174+
"data": {
22175+
"$ref": "#/components/schemas/FaceGetCenter"
22176+
},
22177+
"type": {
22178+
"type": "string",
22179+
"enum": [
22180+
"face_get_center"
22181+
]
22182+
}
22183+
},
22184+
"required": [
22185+
"data",
22186+
"type"
22187+
]
22188+
},
2219222189
{
2219322190
"description": "The response to the 'FaceGetGradient' endpoint",
2219422191
"type": "object",
@@ -23374,7 +23371,7 @@
2337423371
]
2337523372
},
2337623373
{
23377-
"description": "A circular arc segment.",
23374+
"description": "A circular arc segment. Arcs can be drawn clockwise when start > end.",
2337823375
"type": "object",
2337923376
"properties": {
2338023377
"center": {
@@ -23481,7 +23478,7 @@
2348123478
"type": "object",
2348223479
"properties": {
2348323480
"offset": {
23484-
"description": "Offset of the arc.",
23481+
"description": "Offset of the arc. Negative values will arc clockwise.",
2348523482
"allOf": [
2348623483
{
2348723484
"$ref": "#/components/schemas/Angle"
@@ -23510,7 +23507,7 @@
2351023507
]
2351123508
},
2351223509
{
23513-
"description": "Adds a tangent arc from current pen position to the new position.",
23510+
"description": "Adds a tangent arc from current pen position to the new position. Arcs will choose a clockwise or counter-clockwise direction based on the arc end position.",
2351423511
"type": "object",
2351523512
"properties": {
2351623513
"angle_snap_increment": {
@@ -23810,6 +23807,34 @@
2381023807
"z"
2381123808
]
2381223809
},
23810+
"Point4d": {
23811+
"description": "A point in homogeneous (4D) space",
23812+
"type": "object",
23813+
"properties": {
23814+
"w": {
23815+
"type": "number",
23816+
"format": "float"
23817+
},
23818+
"x": {
23819+
"type": "number",
23820+
"format": "float"
23821+
},
23822+
"y": {
23823+
"type": "number",
23824+
"format": "float"
23825+
},
23826+
"z": {
23827+
"type": "number",
23828+
"format": "float"
23829+
}
23830+
},
23831+
"required": [
23832+
"w",
23833+
"x",
23834+
"y",
23835+
"z"
23836+
]
23837+
},
2381323838
"Pong": {
2381423839
"description": "The response from the `/ping` endpoint.",
2381523840
"type": "object",

0 commit comments

Comments
 (0)