wangbo/ComfyUI
1
0
Fork 0
mirror of https://github.com/comfyanonymous/ComfyUI.git synced 2026-01-10 06:10:50 +08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Update OpenAPI spec to be more accurate

Browse Source
This commit is contained in:
doctorpangloss 2024-10-11 13:59:57 -07:00
parent 79b465faf2
commit b5df6c64fa
1 changed files with 8 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
comfy/api/openapi.yaml
View File

@ -406,17 +406,18 @@ paths:
schema:
description: |
The complete outputs dictionary from the workflow.
Additionally, a list of URLs to binary outputs, whenever save nodes are used.
For each SaveImage node, there will be two URLs: the internal URL returned by the worker, and
the URL for the image based on the `--external-address` / `COMFYUI_EXTERNAL_ADDRESS` configuration.
type: object
required:
- urls
- outputs
properties:
urls:
deprecated: true
description: |
A deprecated list of URLs to binary outputs, whenever save nodes are used.
For each SaveImage node, there will be two URLs: the internal URL returned by the worker, and
the URL for the image based on the `--external-address` / `COMFYUI_EXTERNAL_ADDRESS` configuration.
type: array
items:
type: string
@ -424,23 +425,6 @@ paths:
$ref: "#/components/schemas/Outputs"
example:
outputs: { }
urls: [ "http://127.0.0.1:8188/view?filename=ComfyUI_00001_.png&type=output", "https://comfyui.example.com/view?filename=ComfyUI_00001_.png&type=output" ]
multipart/mixed:
encoding:
"^\\d+$":
contentType: image/png, image/jpeg, image/webp
schema:
type: object
description: |
Each of the output nodes' binary values for images, and the "outputs" json object.
properties:
outputs:
$ref: "#/components/schemas/Outputs"
additionalProperties:
patternProperties:
"^\\d+$":
type: string
format: binary
202:
description: |
The prompt was successfully queued.
@ -504,16 +488,11 @@ paths:
enum:
- "application/json"
- "image/png"
- "multipart/mixed"
- "application/json+respond-async"
- "image/png+respond-async"
- "multipart/mixed+respond-async"
required: false
description: |
Specifies the media type the client is willing to receive.
multipart/mixed will soon be supported to return all the images from the workflow.
If +respond-async is specified after your Accept mimetype, the request will be run async and you will get 202 when the prompt was queued.
- in: header
name: Prefer
@ -795,7 +774,7 @@ components:
type: string
Outputs:
description: |
The keys are node IDs, the values are output objects
The keys are node IDs, the values are output objects.
type: object
additionalProperties:
$ref: "#/components/schemas/Output"