wangbo/ComfyUI
1
0
Fork 0
mirror of https://github.com/comfyanonymous/ComfyUI.git synced 2026-05-20 22:17:31 +08:00
Code Issues Actions 22 Packages Projects Releases Wiki Activity

docs(openapi): deprecate /api/upload/mask in favor of /api/upload/image (#13968)
Some checks are pending
Python Linting / Run Ruff (push) Waiting to run
Details
Python Linting / Run Pylint (push) Waiting to run
Details
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.10, [self-hosted Linux], stable) (push) Waiting to run
Details
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.11, [self-hosted Linux], stable) (push) Waiting to run
Details
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.12, [self-hosted Linux], stable) (push) Waiting to run
Details
Full Comfy CI Workflow Runs / test-unix-nightly (12.1, , linux, 3.11, [self-hosted Linux], nightly) (push) Waiting to run
Details
Execution Tests / test (macos-latest) (push) Waiting to run
Details
Execution Tests / test (ubuntu-latest) (push) Waiting to run
Details
Execution Tests / test (windows-latest) (push) Waiting to run
Details
Test server launches without errors / test (push) Waiting to run
Details
Unit Tests / test (macos-latest) (push) Waiting to run
Details
Unit Tests / test (ubuntu-latest) (push) Waiting to run
Details
Unit Tests / test (windows-2022) (push) Waiting to run
Details

Browse Source 
Mark the uploadMask operation as deprecated and point clients at
/api/upload/image. The mask-compositing behavior the endpoint provides
(alpha-compositing the supplied mask onto an original_ref image) is now
expected to happen client-side, with the composited result uploaded
through the unified /api/upload/image path.

The endpoint continues to function for older clients; no runtime
behavior changes ship with this commit. Only the OpenAPI annotation
and the human-facing description are updated.
This commit is contained in:
Matt Miller 2026-05-18 21:19:51 -07:00 committed by GitHub
parent a4382e056e
commit 6b61918a16
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
openapi.yaml
View File

@ -485,8 +485,15 @@ paths:
post:
operationId: uploadMask
tags: [upload]
summary: Upload a mask image
description: Uploads a mask image associated with a previously-uploaded reference image.
deprecated: true
summary: Upload a mask image (deprecated)
description: |
Deprecated. Clients should composite the mask onto the source image
client-side and upload the resulting image via POST /api/upload/image
instead. This endpoint will continue to function for older clients,
but will not receive new features.
Uploads a mask image associated with a previously-uploaded reference image.
requestBody:
required: true
content: