@myronsi/messenger-api 2.0.0-alpha.6.next.48 → 2.0.0-alpha.8.next.50

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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:
+
+- New `GET /search/messages`: full-text search across all chats of the caller, with filters (`chat_id`, `sender_id`,
+  `type`, `from`, `to`) and `search_after` paging.
+- `SearchHit.highlight` wraps the matched words in U+E000 and U+E001.
+- `GET /chats/{chat_id}/messages/search` can answer `429` (searches are rate limited).
+
 ## 2.0.0-alpha.6
 
 Groups, found while implementing them:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.6. Do not edit. */
-export declare const API_VERSION: "2.0.0-alpha.6";
+/* 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.6";
+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.6
+  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" }
@@ -1127,6 +1151,7 @@ paths:
         "401": { $ref: "#/components/responses/Unauthorized" }
         "404": { $ref: "#/components/responses/NotFound" }
         "422": { $ref: "#/components/responses/ValidationFailed" }
+        "429": { $ref: "#/components/responses/TooManyRequests" }
   /chats/{chat_id}/media:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"
@@ -1240,6 +1265,62 @@ paths:
         "422": { $ref: "#/components/responses/ValidationFailed" }
         "429": { $ref: "#/components/responses/TooManyRequests" }
 
+  # -------------------------------------------------------------- search
+  /search/messages:
+    parameters:
+      - $ref: "#/components/parameters/ClientVersion"
+      - $ref: "#/components/parameters/ClientApiVersion"
+    get:
+      tags: [messages]
+      operationId: searchAllMessages
+      summary: Search messages in all my chats
+      description: |
+        Full-text search across every chat the caller is in, newest first. Only chats the caller
+        is a member of are searched, messages they deleted for themselves are left out, and every
+        hit is checked against the message store before it is returned (a deleted message never
+        shows, even when the index lags behind). Edits and deletions reach the results within a
+        few seconds.
+      parameters:
+        - name: q
+          in: query
+          required: true
+          schema: { type: string, minLength: 2, maxLength: 128 }
+        - name: chat_id
+          in: query
+          description: Only this chat
+          schema: { $ref: "#/components/schemas/Id" }
+        - name: sender_id
+          in: query
+          description: Only messages of this user
+          schema: { $ref: "#/components/schemas/Id" }
+        - name: type
+          in: query
+          schema:
+            type: string
+            enum: [text, file, voice]
+        - name: from
+          in: query
+          description: Messages created at or after this time
+          schema: { $ref: "#/components/schemas/Timestamp" }
+        - name: to
+          in: query
+          description: Messages created before this time
+          schema: { $ref: "#/components/schemas/Timestamp" }
+        - $ref: "#/components/parameters/Limit"
+        - $ref: "#/components/parameters/After"
+      responses:
+        "426": { $ref: "#/components/responses/ClientOutdated" }
+        "400": { $ref: "#/components/responses/BadRequest" }
+        "200":
+          description: Matches, newest first
+          content:
+            application/json:
+              schema: { $ref: "#/components/schemas/MessageSearchPage" }
+        "401": { $ref: "#/components/responses/Unauthorized" }
+        "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
+        "429": { $ref: "#/components/responses/TooManyRequests" }
+
   # ------------------------------------------------------------ requests
   /requests:
     parameters:
@@ -2196,7 +2277,11 @@ components:
         message: { $ref: "#/components/schemas/Message" }
         highlight:
           type: [string, "null"]
-          description: Plain-text excerpt; never HTML.
+          description: |
+            Plain-text excerpt of the matching text or file name; never HTML. The matched words are
+            wrapped in U+E000 (start) and U+E001 (end), characters of the Unicode private use area,
+            so a client can mark them without parsing markup. `null` when the message matched without
+            an excerpt.
     MessageSearchPage:
       type: object
       required: [items, next_cursor]

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.6. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.8. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -990,6 +990,35 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/search/messages": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Search messages in all my chats
+         * @description Full-text search across every chat the caller is in, newest first. Only chats the caller
+         *     is a member of are searched, messages they deleted for themselves are left out, and every
+         *     hit is checked against the message store before it is returned (a deleted message never
+         *     shows, even when the index lags behind). Edits and deletions reach the results within a
+         *     few seconds.
+         */
+        get: operations["searchAllMessages"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/requests": {
         parameters: {
             query?: never;
@@ -1550,7 +1579,12 @@ export interface components {
         };
         SearchHit: {
             message: components["schemas"]["Message"];
-            /** @description Plain-text excerpt; never HTML. */
+            /**
+             * @description Plain-text excerpt of the matching text or file name; never HTML. The matched words are
+             *     wrapped in U+E000 (start) and U+E001 (end), characters of the Unicode private use area,
+             *     so a client can mark them without parsing markup. `null` when the message matched without
+             *     an excerpt.
+             */
             highlight?: string | null;
         };
         MessageSearchPage: {
@@ -2769,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"];
         };
     };
@@ -2942,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"];
         };
     };
@@ -3317,6 +3404,7 @@ export interface operations {
             404: components["responses"]["NotFound"];
             422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
+            429: components["responses"]["TooManyRequests"];
         };
     };
     listChatMedia: {
@@ -3467,6 +3555,52 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    searchAllMessages: {
+        parameters: {
+            query: {
+                q: string;
+                /** @description Only this chat */
+                chat_id?: components["schemas"]["Id"];
+                /** @description Only messages of this user */
+                sender_id?: components["schemas"]["Id"];
+                type?: "text" | "file" | "voice";
+                /** @description Messages created at or after this time */
+                from?: components["schemas"]["Timestamp"];
+                /** @description Messages created before this time */
+                to?: components["schemas"]["Timestamp"];
+                /** @description Page size */
+                limit?: components["parameters"]["Limit"];
+                /** @description Opaque `next_cursor` of the previous page */
+                after?: components["parameters"]["After"];
+            };
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Matches, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageSearchPage"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
+            426: components["responses"]["ClientOutdated"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     listApprovalRequests: {
         parameters: {
             query?: {

package/dist/ws-events.d.ts

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

package/dist/ws-events.schema.json

@@ -1178,7 +1178,7 @@
             "string",
             "null"
           ],
-          "description": "Plain-text excerpt; never HTML."
+          "description": "Plain-text excerpt of the matching text or file name; never HTML. The matched words are\nwrapped in U+E000 (start) and U+E001 (end), characters of the Unicode private use area,\nso a client can mark them without parsing markup. `null` when the message matched without\nan excerpt.\n"
         }
       }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myronsi/messenger-api",
-  "version": "2.0.0-alpha.6.next.48",
+  "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": {