Skip to content

Commit cb42ce7

Browse files
Update api spec (#1240)
YOYO NEW API SPEC! Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 6a0db43 commit cb42ce7

File tree

1 file changed

+246
-0
lines changed

1 file changed

+246
-0
lines changed

spec.json

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16988,6 +16988,57 @@
1698816988
}
1698916989
]
1699016990
},
16991+
"BooleanIntersection": {
16992+
"description": "The response from the 'BooleanIntersection'.",
16993+
"type": "object",
16994+
"properties": {
16995+
"extra_solid_ids": {
16996+
"description": "If the operation produced just one solid, then its ID will be the ID of the modeling command request. But if any extra solids are produced, then their IDs will be included here.",
16997+
"type": "array",
16998+
"items": {
16999+
"type": "string",
17000+
"format": "uuid"
17001+
}
17002+
}
17003+
},
17004+
"required": [
17005+
"extra_solid_ids"
17006+
]
17007+
},
17008+
"BooleanSubtract": {
17009+
"description": "The response from the 'BooleanSubtract'.",
17010+
"type": "object",
17011+
"properties": {
17012+
"extra_solid_ids": {
17013+
"description": "If the operation produced just one solid, then its ID will be the ID of the modeling command request. But if any extra solids are produced, then their IDs will be included here.",
17014+
"type": "array",
17015+
"items": {
17016+
"type": "string",
17017+
"format": "uuid"
17018+
}
17019+
}
17020+
},
17021+
"required": [
17022+
"extra_solid_ids"
17023+
]
17024+
},
17025+
"BooleanUnion": {
17026+
"description": "The response from the 'BooleanUnion'.",
17027+
"type": "object",
17028+
"properties": {
17029+
"extra_solid_ids": {
17030+
"description": "If the operation produced just one solid, then its ID will be the ID of the modeling command request. But if any extra solids are produced, then their IDs will be included here.",
17031+
"type": "array",
17032+
"items": {
17033+
"type": "string",
17034+
"format": "uuid"
17035+
}
17036+
}
17037+
},
17038+
"required": [
17039+
"extra_solid_ids"
17040+
]
17041+
},
1699117042
"CacheMetadata": {
1699217043
"description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.",
1699317044
"type": "object",
@@ -22264,6 +22315,15 @@
2226422315
}
2226522316
]
2226622317
},
22318+
"opposite": {
22319+
"description": "Should the extrusion also extrude in the opposite direction? If so, this specifies its distance.",
22320+
"default": "None",
22321+
"allOf": [
22322+
{
22323+
"$ref": "#/components/schemas/OppositeForLengthUnit"
22324+
}
22325+
]
22326+
},
2226722327
"target": {
2226822328
"description": "Which sketch to extrude. Must be a closed 2D solid.",
2226922329
"allOf": [
@@ -22356,6 +22416,15 @@
2235622416
"description": "If true, the axis is interpreted within the 2D space of the solid 2D's plane",
2235722417
"type": "boolean"
2235822418
},
22419+
"opposite": {
22420+
"description": "Should the revolution also revolve in the opposite direction along the given axis? If so, this specifies its angle.",
22421+
"default": "None",
22422+
"allOf": [
22423+
{
22424+
"$ref": "#/components/schemas/OppositeForAngle"
22425+
}
22426+
]
22427+
},
2235922428
"origin": {
2236022429
"description": "The origin of the extrusion axis",
2236122430
"allOf": [
@@ -22458,6 +22527,15 @@
2245822527
"type": "string",
2245922528
"format": "uuid"
2246022529
},
22530+
"opposite": {
22531+
"description": "Should the revolution also revolve in the opposite direction along the given axis? If so, this specifies its angle.",
22532+
"default": "None",
22533+
"allOf": [
22534+
{
22535+
"$ref": "#/components/schemas/OppositeForAngle"
22536+
}
22537+
]
22538+
},
2246122539
"target": {
2246222540
"description": "Which sketch to revolve. Must be a closed 2D solid.",
2246322541
"allOf": [
@@ -25829,6 +25907,114 @@
2582925907
"type"
2583025908
]
2583125909
},
25910+
{
25911+
"description": "Create a new solid from combining other smaller solids. In other words, every part of the input solids will be included in the output solid.",
25912+
"type": "object",
25913+
"properties": {
25914+
"solid_ids": {
25915+
"description": "Which solids to union together. Cannot be empty.",
25916+
"type": "array",
25917+
"items": {
25918+
"type": "string",
25919+
"format": "uuid"
25920+
}
25921+
},
25922+
"tolerance": {
25923+
"description": "The maximum acceptable surface gap computed between the joined solids. Must be positive (i.e. greater than zero).",
25924+
"allOf": [
25925+
{
25926+
"$ref": "#/components/schemas/LengthUnit"
25927+
}
25928+
]
25929+
},
25930+
"type": {
25931+
"type": "string",
25932+
"enum": [
25933+
"boolean_union"
25934+
]
25935+
}
25936+
},
25937+
"required": [
25938+
"solid_ids",
25939+
"tolerance",
25940+
"type"
25941+
]
25942+
},
25943+
{
25944+
"description": "Create a new solid from intersecting several other solids. In other words, the part of the input solids where they all overlap will be the output solid.",
25945+
"type": "object",
25946+
"properties": {
25947+
"solid_ids": {
25948+
"description": "Which solids to intersect together",
25949+
"type": "array",
25950+
"items": {
25951+
"type": "string",
25952+
"format": "uuid"
25953+
}
25954+
},
25955+
"tolerance": {
25956+
"description": "The maximum acceptable surface gap computed between the joined solids. Must be positive (i.e. greater than zero).",
25957+
"allOf": [
25958+
{
25959+
"$ref": "#/components/schemas/LengthUnit"
25960+
}
25961+
]
25962+
},
25963+
"type": {
25964+
"type": "string",
25965+
"enum": [
25966+
"boolean_intersection"
25967+
]
25968+
}
25969+
},
25970+
"required": [
25971+
"solid_ids",
25972+
"tolerance",
25973+
"type"
25974+
]
25975+
},
25976+
{
25977+
"description": "Create a new solid from subtracting several other solids. The 'target' is what will be cut from. The 'tool' is what will be cut out from 'target'.",
25978+
"type": "object",
25979+
"properties": {
25980+
"target_ids": {
25981+
"description": "Geometry to cut out from.",
25982+
"type": "array",
25983+
"items": {
25984+
"type": "string",
25985+
"format": "uuid"
25986+
}
25987+
},
25988+
"tolerance": {
25989+
"description": "The maximum acceptable surface gap computed between the target and the solids cut out from it. Must be positive (i.e. greater than zero).",
25990+
"allOf": [
25991+
{
25992+
"$ref": "#/components/schemas/LengthUnit"
25993+
}
25994+
]
25995+
},
25996+
"tool_ids": {
25997+
"description": "Will be cut out from the 'target'.",
25998+
"type": "array",
25999+
"items": {
26000+
"type": "string",
26001+
"format": "uuid"
26002+
}
26003+
},
26004+
"type": {
26005+
"type": "string",
26006+
"enum": [
26007+
"boolean_subtract"
26008+
]
26009+
}
26010+
},
26011+
"required": [
26012+
"target_ids",
26013+
"tolerance",
26014+
"tool_ids",
26015+
"type"
26016+
]
26017+
},
2583226018
{
2583326019
"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.",
2583426020
"type": "object",
@@ -28352,6 +28538,60 @@
2835228538
"data",
2835328539
"type"
2835428540
]
28541+
},
28542+
{
28543+
"type": "object",
28544+
"properties": {
28545+
"data": {
28546+
"$ref": "#/components/schemas/BooleanUnion"
28547+
},
28548+
"type": {
28549+
"type": "string",
28550+
"enum": [
28551+
"boolean_union"
28552+
]
28553+
}
28554+
},
28555+
"required": [
28556+
"data",
28557+
"type"
28558+
]
28559+
},
28560+
{
28561+
"type": "object",
28562+
"properties": {
28563+
"data": {
28564+
"$ref": "#/components/schemas/BooleanIntersection"
28565+
},
28566+
"type": {
28567+
"type": "string",
28568+
"enum": [
28569+
"boolean_intersection"
28570+
]
28571+
}
28572+
},
28573+
"required": [
28574+
"data",
28575+
"type"
28576+
]
28577+
},
28578+
{
28579+
"type": "object",
28580+
"properties": {
28581+
"data": {
28582+
"$ref": "#/components/schemas/BooleanSubtract"
28583+
},
28584+
"type": {
28585+
"type": "string",
28586+
"enum": [
28587+
"boolean_subtract"
28588+
]
28589+
}
28590+
},
28591+
"required": [
28592+
"data",
28593+
"type"
28594+
]
2835528595
}
2835628596
]
2835728597
},
@@ -28646,6 +28886,12 @@
2864628886
}
2864728887
}
2864828888
},
28889+
"OppositeForAngle": {
28890+
"type": "string"
28891+
},
28892+
"OppositeForLengthUnit": {
28893+
"type": "string"
28894+
},
2864928895
"Org": {
2865028896
"description": "An organization.",
2865128897
"type": "object",

0 commit comments

Comments
 (0)