Skip to content

Commit 6b61918

Browse files
authored
docs(openapi): deprecate /api/upload/mask in favor of /api/upload/image (Comfy-Org#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.
1 parent a4382e0 commit 6b61918

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

openapi.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,15 @@ paths:
485485
post:
486486
operationId: uploadMask
487487
tags: [upload]
488-
summary: Upload a mask image
489-
description: Uploads a mask image associated with a previously-uploaded reference image.
488+
deprecated: true
489+
summary: Upload a mask image (deprecated)
490+
description: |
491+
Deprecated. Clients should composite the mask onto the source image
492+
client-side and upload the resulting image via POST /api/upload/image
493+
instead. This endpoint will continue to function for older clients,
494+
but will not receive new features.
495+
496+
Uploads a mask image associated with a previously-uploaded reference image.
490497
requestBody:
491498
required: true
492499
content:

0 commit comments

Comments
 (0)