mirror of
https://github.com/comfyanonymous/ComfyUI.git
synced 2026-05-20 20:49:03 +00:00
docs(openapi): deprecate /api/upload/mask in favor of /api/upload/image (#13968)
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:
11
openapi.yaml
11
openapi.yaml
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user