@myronsi/messenger-api 2.0.0-alpha.5.next.46 → 2.0.0-alpha.6.next.48

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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:

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.0.0-alpha.5. Do not edit. */
-export declare const API_VERSION: "2.0.0-alpha.5";
+/* 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.5";
+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.5
+  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
@@ -1333,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:
@@ -1348,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}:
@@ -1411,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:
@@ -1427,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"
@@ -1501,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:
@@ -1517,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.5. Do not edit. */
+/* Generated from api/openapi.yaml 2.0.0-alpha.6. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -1078,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;
@@ -1127,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;
@@ -1202,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;
@@ -3622,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"];
@@ -3758,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"];
         };
     };
@@ -3900,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.5. 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.5.next.46",
+  "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": {