@giveitsmaller/contracts 0.33.0 → 0.34.0

package/dist/openapi/models/WorkflowWarning.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarning.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarningSeverity.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarningSeverity.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/runtime.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/runtime.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.96.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/operations/compress.d.ts

@@ -1,53 +1,126 @@
 export declare enum CompressImageJpegMetadata {
-    All = "all"
+    All = "all",
+    Keep = "keep"
 }
 export declare enum CompressImageJpegOutputFormat {
     Original = "original",
     Webp = "webp"
 }
+export declare enum CompressImageJpegFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
 export interface CompressImageJpegOptions {
     quality?: number;
     metadata?: CompressImageJpegMetadata;
     progressive?: boolean;
     output_format?: CompressImageJpegOutputFormat;
+    lossless?: boolean;
+    width?: number;
+    height?: number;
+    fit?: CompressImageJpegFit;
 }
 export declare enum CompressImagePngMetadata {
-    All = "all"
+    All = "all",
+    Keep = "keep"
 }
 export declare enum CompressImagePngOutputFormat {
     Original = "original",
     Webp = "webp"
 }
+export declare enum CompressImagePngFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
 export interface CompressImagePngOptions {
     quality?: number;
     metadata?: CompressImagePngMetadata;
     optimization_level?: number;
     output_format?: CompressImagePngOutputFormat;
+    lossy?: boolean;
+    width?: number;
+    height?: number;
+    fit?: CompressImagePngFit;
 }
 export declare enum CompressImageAvifMetadata {
-    All = "all"
+    All = "all",
+    Keep = "keep"
 }
 export declare enum CompressImageAvifOutputFormat {
     Original = "original",
     Webp = "webp"
 }
+export declare enum CompressImageAvifFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
 export interface CompressImageAvifOptions {
     quality?: number;
     metadata?: CompressImageAvifMetadata;
     avif_speed?: number;
     output_format?: CompressImageAvifOutputFormat;
+    width?: number;
+    height?: number;
+    fit?: CompressImageAvifFit;
+}
+export declare enum CompressImageWebpMetadata {
+    All = "all",
+    Keep = "keep"
+}
+export declare enum CompressImageWebpOutputFormat {
+    Original = "original",
+    Webp = "webp"
+}
+export declare enum CompressImageWebpFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
+export interface CompressImageWebpOptions {
+    quality?: number;
+    metadata?: CompressImageWebpMetadata;
+    output_format?: CompressImageWebpOutputFormat;
+    lossless?: boolean;
+    width?: number;
+    height?: number;
+    fit?: CompressImageWebpFit;
+}
+export declare enum CompressImageSvgMetadata {
+    All = "all",
+    Keep = "keep"
+}
+export declare enum CompressImageSvgOutputFormat {
+    Original = "original",
+    Webp = "webp"
+}
+export interface CompressImageSvgOptions {
+    quality?: number;
+    metadata?: CompressImageSvgMetadata;
+    output_format?: CompressImageSvgOutputFormat;
 }
 export declare enum CompressImageMetadata {
-    All = "all"
+    All = "all",
+    Keep = "keep"
 }
 export declare enum CompressImageOutputFormat {
     Original = "original",
     Webp = "webp"
 }
+export declare enum CompressImageFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
 export interface CompressImageOptions {
     quality?: number;
     metadata?: CompressImageMetadata;
     output_format?: CompressImageOutputFormat;
+    width?: number;
+    height?: number;
+    fit?: CompressImageFit;
 }
 export declare enum CompressAudioOutputFormat {
     Original = "original",

package/dist/operations/compress.js

@@ -2,39 +2,93 @@
 export var CompressImageJpegMetadata;
 (function (CompressImageJpegMetadata) {
     CompressImageJpegMetadata["All"] = "all";
+    CompressImageJpegMetadata["Keep"] = "keep";
 })(CompressImageJpegMetadata || (CompressImageJpegMetadata = {}));
 export var CompressImageJpegOutputFormat;
 (function (CompressImageJpegOutputFormat) {
     CompressImageJpegOutputFormat["Original"] = "original";
     CompressImageJpegOutputFormat["Webp"] = "webp";
 })(CompressImageJpegOutputFormat || (CompressImageJpegOutputFormat = {}));
+export var CompressImageJpegFit;
+(function (CompressImageJpegFit) {
+    CompressImageJpegFit["Max"] = "max";
+    CompressImageJpegFit["Crop"] = "crop";
+    CompressImageJpegFit["Scale"] = "scale";
+})(CompressImageJpegFit || (CompressImageJpegFit = {}));
 export var CompressImagePngMetadata;
 (function (CompressImagePngMetadata) {
     CompressImagePngMetadata["All"] = "all";
+    CompressImagePngMetadata["Keep"] = "keep";
 })(CompressImagePngMetadata || (CompressImagePngMetadata = {}));
 export var CompressImagePngOutputFormat;
 (function (CompressImagePngOutputFormat) {
     CompressImagePngOutputFormat["Original"] = "original";
     CompressImagePngOutputFormat["Webp"] = "webp";
 })(CompressImagePngOutputFormat || (CompressImagePngOutputFormat = {}));
+export var CompressImagePngFit;
+(function (CompressImagePngFit) {
+    CompressImagePngFit["Max"] = "max";
+    CompressImagePngFit["Crop"] = "crop";
+    CompressImagePngFit["Scale"] = "scale";
+})(CompressImagePngFit || (CompressImagePngFit = {}));
 export var CompressImageAvifMetadata;
 (function (CompressImageAvifMetadata) {
     CompressImageAvifMetadata["All"] = "all";
+    CompressImageAvifMetadata["Keep"] = "keep";
 })(CompressImageAvifMetadata || (CompressImageAvifMetadata = {}));
 export var CompressImageAvifOutputFormat;
 (function (CompressImageAvifOutputFormat) {
     CompressImageAvifOutputFormat["Original"] = "original";
     CompressImageAvifOutputFormat["Webp"] = "webp";
 })(CompressImageAvifOutputFormat || (CompressImageAvifOutputFormat = {}));
+export var CompressImageAvifFit;
+(function (CompressImageAvifFit) {
+    CompressImageAvifFit["Max"] = "max";
+    CompressImageAvifFit["Crop"] = "crop";
+    CompressImageAvifFit["Scale"] = "scale";
+})(CompressImageAvifFit || (CompressImageAvifFit = {}));
+export var CompressImageWebpMetadata;
+(function (CompressImageWebpMetadata) {
+    CompressImageWebpMetadata["All"] = "all";
+    CompressImageWebpMetadata["Keep"] = "keep";
+})(CompressImageWebpMetadata || (CompressImageWebpMetadata = {}));
+export var CompressImageWebpOutputFormat;
+(function (CompressImageWebpOutputFormat) {
+    CompressImageWebpOutputFormat["Original"] = "original";
+    CompressImageWebpOutputFormat["Webp"] = "webp";
+})(CompressImageWebpOutputFormat || (CompressImageWebpOutputFormat = {}));
+export var CompressImageWebpFit;
+(function (CompressImageWebpFit) {
+    CompressImageWebpFit["Max"] = "max";
+    CompressImageWebpFit["Crop"] = "crop";
+    CompressImageWebpFit["Scale"] = "scale";
+})(CompressImageWebpFit || (CompressImageWebpFit = {}));
+export var CompressImageSvgMetadata;
+(function (CompressImageSvgMetadata) {
+    CompressImageSvgMetadata["All"] = "all";
+    CompressImageSvgMetadata["Keep"] = "keep";
+})(CompressImageSvgMetadata || (CompressImageSvgMetadata = {}));
+export var CompressImageSvgOutputFormat;
+(function (CompressImageSvgOutputFormat) {
+    CompressImageSvgOutputFormat["Original"] = "original";
+    CompressImageSvgOutputFormat["Webp"] = "webp";
+})(CompressImageSvgOutputFormat || (CompressImageSvgOutputFormat = {}));
 export var CompressImageMetadata;
 (function (CompressImageMetadata) {
     CompressImageMetadata["All"] = "all";
+    CompressImageMetadata["Keep"] = "keep";
 })(CompressImageMetadata || (CompressImageMetadata = {}));
 export var CompressImageOutputFormat;
 (function (CompressImageOutputFormat) {
     CompressImageOutputFormat["Original"] = "original";
     CompressImageOutputFormat["Webp"] = "webp";
 })(CompressImageOutputFormat || (CompressImageOutputFormat = {}));
+export var CompressImageFit;
+(function (CompressImageFit) {
+    CompressImageFit["Max"] = "max";
+    CompressImageFit["Crop"] = "crop";
+    CompressImageFit["Scale"] = "scale";
+})(CompressImageFit || (CompressImageFit = {}));
 export var CompressAudioOutputFormat;
 (function (CompressAudioOutputFormat) {
     CompressAudioOutputFormat["Original"] = "original";

package/dist/operations/compress.metadata.js

@@ -10,7 +10,11 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 progressive: {
                     per_value_availability: {},
@@ -18,6 +22,19 @@ export const compressMetadata = {
                 output_format: {
                     per_value_availability: {},
                 },
+                lossless: {
+                    availability: 'planned',
+                    per_value_availability: {},
+                },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },
@@ -29,7 +46,11 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 optimization_level: {
                     per_value_availability: {},
@@ -37,6 +58,19 @@ export const compressMetadata = {
                 output_format: {
                     per_value_availability: {},
                 },
+                lossy: {
+                    availability: 'planned',
+                    per_value_availability: {},
+                },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },
@@ -49,7 +83,11 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 avif_speed: {
                     per_value_availability: {},
@@ -57,10 +95,52 @@ export const compressMetadata = {
                 output_format: {
                     per_value_availability: {},
                 },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },
-        image: {
+        image_webp: {
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
+                quality: {
+                    per_value_availability: {},
+                },
+                metadata: {
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
+                },
+                output_format: {
+                    per_value_availability: {},
+                },
+                lossless: {
+                    availability: 'planned',
+                    per_value_availability: {},
+                },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
+            },
+            per_input_options: {},
+        },
+        image_svg: {
             processing_class: {},
             per_mime_availability: {},
             options: {
@@ -68,11 +148,44 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
+                },
+                output_format: {
+                    per_value_availability: {},
+                },
+            },
+            per_input_options: {},
+        },
+        image: {
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
+                quality: {
                     per_value_availability: {},
                 },
+                metadata: {
+                    per_value_availability: {
+                        keep: {
+                            availability: 'planned',
+                        },
+                    },
+                },
                 output_format: {
                     per_value_availability: {},
                 },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },

package/openapi/api.yaml

@@ -89,7 +89,7 @@ info:
     of truth instead of hardcoding magic numbers. A runtime
     `GET /api/uploads/limits` endpoint for dynamic discovery
     (per-tier / per-environment overrides) is a deferred follow-up.
-  version: 2.96.0
+  version: 2.97.0
   contact:
     name: API Support
 
@@ -11290,6 +11290,32 @@ components:
             Set condition: `{ "width": "set", "height": "set", "logic": "or" }` — option applies when width or height is provided.
             The "set" sentinel means the option has any value. "logic" can be "and" (default) or "or".
           additionalProperties: true
+        honored_on:
+          type: array
+          description: |
+            Route-applicability tag for the image "Output" facade (per
+            `schemas/FORMAT.md` §"Route-aware Output model"). Lists the route(s)
+            whose worker actually honours this option. The Output op routes by
+            comparing the authored/resolved `output_format` to the input format:
+            `same_format` (output_format == input, or `original`) runs the
+            optimiser path; `format_change` (output_format != input) runs the
+            transcoder path. An option `honored_on: [same_format]` is read only
+            on the optimiser path (e.g. JPEG `progressive`); `[format_change]`
+            only on the transcoder path (e.g. `background` alpha-flatten to JPEG).
+            ABSENT ≡ honored on every route the option's `depends_on` already
+            admits (back-compat — existing options need no tag). Orthogonal to
+            `availability`: a `planned` option still declares the route it WILL
+            be honoured on. Consumers derive option visibility from
+            `honored_on` ∩ active-route ∩ (availability != planned) ∩ depends_on.
+            Token validity (subset of {same_format, format_change}) is verified
+            by `make check-image-output-routes`. The derived per-(media, route,
+            output_format) projection lives at
+            `accepted-options/image-output-routes.json`.
+          items:
+            type: string
+            enum:
+              - same_format
+              - format_change
 
     ProcessingClassConstraints:
       type: object

package/operation-capabilities/operation-capabilities.json

@@ -471,5 +471,5 @@
       "isAnimated": "maybe"
     }
   },
-  "schema_version": "2.96.0"
+  "schema_version": "2.97.0"
 }