Update api spec (#247)

YOYO NEW API SPEC!

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
zoo-github-actions-auth[bot]
2024-08-09 16:48:12 -07:00
committed by GitHub
parent af6cf97292
commit 9cbda88fcc

View File

@ -506,6 +506,15 @@
"schema": { "schema": {
"$ref": "#/components/schemas/FileExportFormat" "$ref": "#/components/schemas/FileExportFormat"
} }
},
{
"in": "query",
"name": "kcl",
"description": "If we should output the kcl for the model.",
"schema": {
"nullable": true,
"type": "boolean"
}
} }
], ],
"requestBody": { "requestBody": {
@ -12693,6 +12702,13 @@
"enum": [ "enum": [
"text_to_cad" "text_to_cad"
] ]
},
{
"description": "Text to KCL.",
"type": "string",
"enum": [
"text_to_kcl"
]
} }
] ]
}, },
@ -14012,6 +14028,11 @@
"description": "Text to CAD.", "description": "Text to CAD.",
"type": "object", "type": "object",
"properties": { "properties": {
"code": {
"nullable": true,
"description": "The code for the model. This is optional but will be required in the future once we are at v1.",
"type": "string"
},
"completed_at": { "completed_at": {
"nullable": true, "nullable": true,
"title": "DateTime", "title": "DateTime",
@ -14047,6 +14068,14 @@
} }
] ]
}, },
"model": {
"description": "The model being used.",
"allOf": [
{
"$ref": "#/components/schemas/TextToCadModel"
}
]
},
"model_version": { "model_version": {
"description": "The version of the model.", "description": "The version of the model.",
"type": "string" "type": "string"
@ -14111,6 +14140,7 @@
"required": [ "required": [
"created_at", "created_at",
"id", "id",
"model",
"model_version", "model_version",
"output_format", "output_format",
"prompt", "prompt",
@ -25288,6 +25318,11 @@
"description": "A response from a text to CAD prompt.", "description": "A response from a text to CAD prompt.",
"type": "object", "type": "object",
"properties": { "properties": {
"code": {
"nullable": true,
"description": "The code for the model. This is optional but will be required in the future once we are at v1.",
"type": "string"
},
"completed_at": { "completed_at": {
"nullable": true, "nullable": true,
"title": "DateTime", "title": "DateTime",
@ -25323,6 +25358,14 @@
} }
] ]
}, },
"model": {
"description": "The model being used.",
"allOf": [
{
"$ref": "#/components/schemas/TextToCadModel"
}
]
},
"model_version": { "model_version": {
"description": "The version of the model.", "description": "The version of the model.",
"type": "string" "type": "string"
@ -25381,6 +25424,7 @@
"required": [ "required": [
"created_at", "created_at",
"id", "id",
"model",
"model_version", "model_version",
"output_format", "output_format",
"prompt", "prompt",
@ -25402,6 +25446,25 @@
"prompt" "prompt"
] ]
}, },
"TextToCadModel": {
"description": "A type of Text-to-CAD model.",
"oneOf": [
{
"description": "CAD.",
"type": "string",
"enum": [
"cad"
]
},
{
"description": "KCL.",
"type": "string",
"enum": [
"kcl"
]
}
]
},
"TextToCadResultsPage": { "TextToCadResultsPage": {
"description": "A single page of results", "description": "A single page of results",
"type": "object", "type": "object",