@myronsi/messenger-api 2.1.0-alpha.4 → 2.1.0-alpha.5.next.70

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.1.0-alpha.5
+
+- A user's `avatar_url` adds `?rev={revision}`, which changes with every new avatar. `GET /users/{user_id}/avatar`
+  accepts `rev`; while it matches the current avatar, the answer is `Cache-Control: private, max-age=31536000, immutable`.
+- `GET /attachments/{attachment_id}/content` is cached for a year (`immutable`): an attachment's bytes never change.
+
 ## 2.1.0-alpha.4
 
 - Editing a file message accepts an empty `content` (HTTP `PATCH /messages/{message_id}` and the WebSocket `edit`

package/dist/index.d.ts

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

package/dist/index.js

@@ -1 +1 @@
-export const API_VERSION = "2.1.0-alpha.4";
+export const API_VERSION = "2.1.0-alpha.5";

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.1.0-alpha.4
+  version: 2.1.0-alpha.5
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -825,12 +825,18 @@ paths:
       summary: Current avatar image
       description: |
         Respects the avatar visibility of the user; falls back to the default avatar. With `version`, an
-        earlier avatar of the history (`AvatarVersion.url`).
+        earlier avatar of the history (`AvatarVersion.url`). `avatar_url` carries `rev`, the revision of the
+        current avatar: while it matches, the answer may be cached for a year (`immutable`), because a new
+        avatar gets a new `rev` and so a new URL.
       parameters:
         - name: version
           in: query
           description: "`id` of an `AvatarVersion` of this user."
           schema: { $ref: "#/components/schemas/Id" }
+        - name: rev
+          in: query
+          description: Revision of the current avatar, as given in `avatar_url`.
+          schema: { type: string, maxLength: 64 }
       responses:
         "426": { $ref: "#/components/responses/ClientOutdated" }
         "400": { $ref: "#/components/responses/BadRequest" }
@@ -2518,7 +2524,7 @@ components:
           description: The requesting user's own name for this user, if set.
         avatar_url:
           type: [string, "null"]
-          description: Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar`).
+          description: Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar?rev={revision}`).
         bio: { type: [string, "null"] }
         is_online: { type: boolean }
         last_seen:

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.4. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.5. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -681,7 +681,9 @@ export interface paths {
         /**
          * Current avatar image
          * @description Respects the avatar visibility of the user; falls back to the default avatar. With `version`, an
-         *     earlier avatar of the history (`AvatarVersion.url`).
+         *     earlier avatar of the history (`AvatarVersion.url`). `avatar_url` carries `rev`, the revision of the
+         *     current avatar: while it matches, the answer may be cached for a year (`immutable`), because a new
+         *     avatar gets a new `rev` and so a new URL.
          */
         get: operations["getUserAvatar"];
         put?: never;
@@ -1756,7 +1758,7 @@ export interface components {
             display_name: string;
             /** @description The requesting user's own name for this user, if set. */
             contact_name?: string | null;
-            /** @description Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar`). */
+            /** @description Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar?rev={revision}`). */
             avatar_url: string | null;
             bio: string | null;
             is_online: boolean;
@@ -3195,6 +3197,8 @@ export interface operations {
             query?: {
                 /** @description `id` of an `AvatarVersion` of this user. */
                 version?: components["schemas"]["Id"];
+                /** @description Revision of the current avatar, as given in `avatar_url`. */
+                rev?: string;
             };
             header?: {
                 /** @description Version of the client app, for logs and the per-client metric. */

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.4. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.5. Do not edit. */
 
 /**
  * Any WebSocket event, in either direction.
@@ -253,7 +253,7 @@ export interface User {
    */
   contact_name?: string | null;
   /**
-   * Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar`).
+   * Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar?rev={revision}`).
    */
   avatar_url: string | null;
   bio: string | null;

package/dist/ws-events.schema.json

@@ -979,7 +979,7 @@
             "string",
             "null"
           ],
-          "description": "Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar`)."
+          "description": "Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar?rev={revision}`)."
         },
         "bio": {
           "type": [

package/package.json

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