@myronsi/messenger-api 2.0.0-alpha.7.next.49 → 2.0.0-alpha.8.next.50

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.0.0-alpha.8
+
+Found by validating every response of the backend's HTTP tests against this contract:
+
+- `GET /attachments/{attachment_id}/content` and `GET /users/{user_id}/avatar` list `206` (byte ranges), `304`
+  (`ETag`) and `416`; the attachment download also its `302` to a signed URL.
+- `POST /ws/ticket` answers `201`, as listed (the server sent `200`).
+- The conventions name the statuses any operation may answer: `413`, `415`, `500`, `503`.
+
 ## 2.0.0-alpha.7
 
 Search:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.7. Do not edit. */
-export declare const API_VERSION: "2.0.0-alpha.7";
+/* Generated from api/openapi.yaml 2.0.0-alpha.8. Do not edit. */
+export declare const API_VERSION: "2.0.0-alpha.8";
 export type { paths, components, operations } from "./schema.js";
 export * from "./ws-events.js";

package/dist/index.js

@@ -1 +1 @@
-export const API_VERSION = "2.0.0-alpha.7";
+export const API_VERSION = "2.0.0-alpha.8";

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.0.0-alpha.7
+  version: 2.0.0-alpha.8
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -25,6 +25,10 @@ info:
       `min_client_api_version` gets `426` with `code: client_outdated`.
     - Files are never referenced by a client-supplied URL: upload with `POST /attachments`,
       then refer to the returned `attachment_id`.
+    - Statuses any operation may answer, not repeated per operation: `413` (body over the size
+      limit, `payload_too_large`) and `415` (a body that is not `application/json`,
+      `unsupported_media_type`) for operations with a body; `500` (a bug) and `503` (a store is
+      away; retry after `Retry-After`) for all.
   license:
     name: MIT
     identifier: MIT
@@ -744,6 +748,15 @@ paths:
           content:
             image/*:
               schema: { type: string, format: binary }
+        "206":
+          description: The requested byte range (`Range` header)
+          content:
+            image/*:
+              schema: { type: string, format: binary }
+        "304":
+          description: Not modified (`If-None-Match` with the `ETag` of an earlier answer)
+        "416":
+          description: The requested range is outside the file
         "401": { $ref: "#/components/responses/Unauthorized" }
         "404": { $ref: "#/components/responses/NotFound" }
   /users/{user_id}/avatars:
@@ -872,6 +885,17 @@ paths:
           content:
             application/octet-stream:
               schema: { type: string, format: binary }
+        "206":
+          description: The requested byte range (`Range` header); players use it to seek
+          content:
+            application/octet-stream:
+              schema: { type: string, format: binary }
+        "304":
+          description: Not modified (`If-None-Match` with the `ETag` of an earlier answer)
+        "416":
+          description: The requested range is outside the file
+        "302":
+          description: Redirect to a short-lived signed URL of object storage (`MEDIA_SIGNED_URLS`); not cached
         "401": { $ref: "#/components/responses/Unauthorized" }
         "403": { $ref: "#/components/responses/Forbidden" }
         "404": { $ref: "#/components/responses/NotFound" }

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.7. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.8. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -2803,9 +2803,32 @@ export interface operations {
                     "image/*": string;
                 };
             };
+            /** @description The requested byte range (`Range` header) */
+            206: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "image/*": string;
+                };
+            };
+            /** @description Not modified (`If-None-Match` with the `ETag` of an earlier answer) */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             400: components["responses"]["BadRequest"];
             401: components["responses"]["Unauthorized"];
             404: components["responses"]["NotFound"];
+            /** @description The requested range is outside the file */
+            416: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             426: components["responses"]["ClientOutdated"];
         };
     };
@@ -2976,10 +2999,40 @@ export interface operations {
                     "application/octet-stream": string;
                 };
             };
+            /** @description The requested byte range (`Range` header); players use it to seek */
+            206: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/octet-stream": string;
+                };
+            };
+            /** @description Redirect to a short-lived signed URL of object storage (`MEDIA_SIGNED_URLS`); not cached */
+            302: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not modified (`If-None-Match` with the `ETag` of an earlier answer) */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             400: components["responses"]["BadRequest"];
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
             404: components["responses"]["NotFound"];
+            /** @description The requested range is outside the file */
+            416: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             426: components["responses"]["ClientOutdated"];
         };
     };

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.7. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.8. Do not edit. */
 
 /**
  * Any WebSocket event, in either direction.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myronsi/messenger-api",
-  "version": "2.0.0-alpha.7.next.49",
+  "version": "2.0.0-alpha.8.next.50",
   "description": "API contract of the Messenger backend: OpenAPI document, WebSocket event schemas and generated TypeScript types",
   "license": "MIT",
   "repository": {