@myronsi/messenger-api 2.0.0-alpha.4.next.44 → 2.0.0-alpha.6.next.48

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.6
+
+Groups, found while implementing them:
+
+- `POST /groups` can answer `403`: a member who does not allow invitations from the caller fails the request.
+- `PUT /groups/{chat_id}/avatar` (`422`: not an image the caller uploaded as an avatar) and
+  `POST /groups/{chat_id}/transfer-owner` (`422`: to yourself) document their validation errors.
+
+## 2.0.0-alpha.5
+
+Chats, found while implementing the chat list:
+
+- `DELETE /chats/{chat_id}` deletes a direct chat for both users (as v1 did), not "for yourself"; a group is `422`.
+- `POST /chats` can answer `422` (a chat with yourself, a too long `initial_message`).
+- `PUT /chats/{chat_id}/pin`: at most 10 pinned chats (`409`).
+- `GET /chats` documents its order, what `last_message` and its `read_by` hold, and that `unread_count` stops at 999.
+- `DELETE /me` can answer `429` (repeated wrong passwords).
+
 ## 2.0.0-alpha.4
 
 Media, found while implementing uploads:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.4. Do not edit. */
-export declare const API_VERSION: "2.0.0-alpha.4";
+/* Generated from api/openapi.yaml 2.0.0-alpha.6. Do not edit. */
+export declare const API_VERSION: "2.0.0-alpha.6";
 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.4";
+export const API_VERSION = "2.0.0-alpha.6";

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.0.0-alpha.4
+  version: 2.0.0-alpha.6
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -324,6 +324,7 @@ paths:
           description: Account deleted
         "401": { $ref: "#/components/responses/Unauthorized" }
         "403": { $ref: "#/components/responses/Forbidden" }
+        "429": { $ref: "#/components/responses/TooManyRequests" }
   /me/avatar:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"
@@ -884,7 +885,12 @@ paths:
       tags: [chats]
       operationId: listChats
       summary: My chats with last message and unread count
-      description: One request replaces `GET /chats/list/{username}` and `GET /groups/list/{username}`; pinned chats come first.
+      description: |
+        One request replaces `GET /chats/list/{username}` and `GET /groups/list/{username}`.
+        Pinned chats come first (most recently pinned first), then the others by their last
+        message (newest first). `last_message` is the newest message the caller can see; in
+        direct chats its `read_by` holds the other user once they read it (with read receipts
+        on), in groups it is empty. `unread_count` stops at 999.
       parameters:
         - $ref: "#/components/parameters/Limit"
         - $ref: "#/components/parameters/After"
@@ -931,6 +937,7 @@ paths:
         "401": { $ref: "#/components/responses/Unauthorized" }
         "403": { $ref: "#/components/responses/Forbidden" }
         "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
         "429": { $ref: "#/components/responses/TooManyRequests" }
   /chats/{chat_id}:
     parameters:
@@ -954,8 +961,11 @@ paths:
     delete:
       tags: [chats]
       operationId: deleteChat
-      summary: Delete a direct chat for yourself
-      description: For groups use `DELETE /groups/{chat_id}` (owner) or `POST /groups/{chat_id}/leave`.
+      summary: Delete a direct chat
+      description: |
+        Deletes the chat and its messages for both users (as v1 did); both get `chat_deleted`.
+        For groups use `DELETE /groups/{chat_id}` (owner) or `POST /groups/{chat_id}/leave`;
+        a group here is `422`.
       responses:
         "426": { $ref: "#/components/responses/ClientOutdated" }
         "400": { $ref: "#/components/responses/BadRequest" }
@@ -963,6 +973,7 @@ paths:
           description: Deleted
         "401": { $ref: "#/components/responses/Unauthorized" }
         "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
   /chats/{chat_id}/pin:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"
@@ -972,6 +983,7 @@ paths:
       tags: [chats]
       operationId: pinChat
       summary: Pin a chat
+      description: At most 10 chats can be pinned (`409` beyond that). Pinning a pinned chat changes nothing.
       responses:
         "426": { $ref: "#/components/responses/ClientOutdated" }
         "400": { $ref: "#/components/responses/BadRequest" }
@@ -1321,7 +1333,9 @@ paths:
       tags: [groups]
       operationId: createGroup
       summary: Create a group
-      description: Members whose `group_invites` setting requires approval get an approval request instead of being added.
+      description: |
+        Members whose `group_invites` setting requires approval get an approval request instead of being added.
+        If any of them does not allow invitations from the caller at all, nothing is created (`403`).
       requestBody:
         required: true
         content:
@@ -1336,6 +1350,7 @@ paths:
               schema: { $ref: "#/components/schemas/Group" }
         "400": { $ref: "#/components/responses/BadRequest" }
         "401": { $ref: "#/components/responses/Unauthorized" }
+        "403": { $ref: "#/components/responses/Forbidden" }
         "422": { $ref: "#/components/responses/ValidationFailed" }
         "429": { $ref: "#/components/responses/TooManyRequests" }
   /groups/{chat_id}:
@@ -1399,6 +1414,7 @@ paths:
       tags: [groups]
       operationId: setGroupAvatar
       summary: Set the group avatar from an uploaded attachment
+      description: The attachment must be an image the caller uploaded with purpose `avatar` (`422` otherwise).
       requestBody:
         required: true
         content:
@@ -1415,6 +1431,7 @@ paths:
         "401": { $ref: "#/components/responses/Unauthorized" }
         "403": { $ref: "#/components/responses/Forbidden" }
         "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
   /groups/{chat_id}/participants:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"
@@ -1489,6 +1506,7 @@ paths:
       tags: [groups]
       operationId: transferGroupOwnership
       summary: Make another member the owner
+      description: The previous owner becomes an admin. Transferring to yourself is `422`.
       requestBody:
         required: true
         content:
@@ -1505,6 +1523,7 @@ paths:
         "401": { $ref: "#/components/responses/Unauthorized" }
         "403": { $ref: "#/components/responses/Forbidden" }
         "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
   /groups/{chat_id}/leave:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.4. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.6. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -746,7 +746,11 @@ export interface paths {
         };
         /**
          * My chats with last message and unread count
-         * @description One request replaces `GET /chats/list/{username}` and `GET /groups/list/{username}`; pinned chats come first.
+         * @description One request replaces `GET /chats/list/{username}` and `GET /groups/list/{username}`.
+         *     Pinned chats come first (most recently pinned first), then the others by their last
+         *     message (newest first). `last_message` is the newest message the caller can see; in
+         *     direct chats its `read_by` holds the other user once they read it (with read receipts
+         *     on), in groups it is empty. `unread_count` stops at 999.
          */
         get: operations["listChats"];
         put?: never;
@@ -782,8 +786,10 @@ export interface paths {
         put?: never;
         post?: never;
         /**
-         * Delete a direct chat for yourself
-         * @description For groups use `DELETE /groups/{chat_id}` (owner) or `POST /groups/{chat_id}/leave`.
+         * Delete a direct chat
+         * @description Deletes the chat and its messages for both users (as v1 did); both get `chat_deleted`.
+         *     For groups use `DELETE /groups/{chat_id}` (owner) or `POST /groups/{chat_id}/leave`;
+         *     a group here is `422`.
          */
         delete: operations["deleteChat"];
         options?: never;
@@ -806,7 +812,10 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** Pin a chat */
+        /**
+         * Pin a chat
+         * @description At most 10 chats can be pinned (`409` beyond that). Pinning a pinned chat changes nothing.
+         */
         put: operations["pinChat"];
         post?: never;
         /** Unpin a chat */
@@ -1069,6 +1078,7 @@ export interface paths {
         /**
          * Create a group
          * @description Members whose `group_invites` setting requires approval get an approval request instead of being added.
+         *     If any of them does not allow invitations from the caller at all, nothing is created (`403`).
          */
         post: operations["createGroup"];
         delete?: never;
@@ -1118,7 +1128,10 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** Set the group avatar from an uploaded attachment */
+        /**
+         * Set the group avatar from an uploaded attachment
+         * @description The attachment must be an image the caller uploaded with purpose `avatar` (`422` otherwise).
+         */
         put: operations["setGroupAvatar"];
         post?: never;
         delete?: never;
@@ -1193,7 +1206,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Make another member the owner */
+        /**
+         * Make another member the owner
+         * @description The previous owner becomes an admin. Transferring to yourself is `422`.
+         */
         post: operations["transferGroupOwnership"];
         delete?: never;
         options?: never;
@@ -2090,6 +2106,7 @@ export interface operations {
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
             426: components["responses"]["ClientOutdated"];
+            429: components["responses"]["TooManyRequests"];
         };
     };
     updateMe: {
@@ -3014,6 +3031,7 @@ export interface operations {
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
             404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
             429: components["responses"]["TooManyRequests"];
         };
@@ -3075,6 +3093,7 @@ export interface operations {
             400: components["responses"]["BadRequest"];
             401: components["responses"]["Unauthorized"];
             404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
         };
     };
@@ -3610,6 +3629,7 @@ export interface operations {
             };
             400: components["responses"]["BadRequest"];
             401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
             422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
             429: components["responses"]["TooManyRequests"];
@@ -3746,6 +3766,7 @@ export interface operations {
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
             404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
         };
     };
@@ -3888,6 +3909,7 @@ export interface operations {
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
             404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
             426: components["responses"]["ClientOutdated"];
         };
     };

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.4. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.6. 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.4.next.44",
+  "version": "2.0.0-alpha.6.next.48",
   "description": "API contract of the Messenger backend: OpenAPI document, WebSocket event schemas and generated TypeScript types",
   "license": "MIT",
   "repository": {