From 6b61918a16cd01dbd55632b148f271b0260c1e40 Mon Sep 17 00:00:00 2001 From: Matt Miller Date: Mon, 18 May 2026 21:19:51 -0700 Subject: [PATCH] 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. --- openapi.yaml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 214962c5c..9a3117e22 100644 --- a/openapi.yaml +++ b/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: