update polling endpoints

ttab · Feb 6, 2025 · 63521e8 · 63521e8
1 parent 93ea4cf
commit 63521e8
Show file tree

Hide file tree

Showing 7 changed files with 430 additions and 414 deletions.
diff --git a/docs/index-openapi.json b/docs/index-openapi.json
@@ -729,7 +729,7 @@
   },
   "info": {
     "title": "index API",
-    "version": "v0.17.7"
+    "version": "v0.17.8"
   },
   "openapi": "3.0.0",
   "paths": {

diff --git a/docs/repository-openapi.json b/docs/repository-openapi.json
@@ -1826,7 +1826,7 @@
   },
   "info": {
     "title": "repository API",
-    "version": "v0.17.7"
+    "version": "v0.17.8"
   },
   "openapi": "3.0.0",
   "paths": {

diff --git a/docs/spell-openapi.json b/docs/spell-openapi.json
@@ -236,7 +236,7 @@
   },
   "info": {
     "title": "spell API",
-    "version": "v0.17.7"
+    "version": "v0.17.8"
   },
   "openapi": "3.0.0",
   "paths": {

diff --git a/docs/user-openapi.json b/docs/user-openapi.json
@@ -44,11 +44,11 @@
       "elephant.user.ListInboxMessagesRequest": {
         "properties": {
           "before_id": {
-            "description": "Fetch messages with IDs before the given `before_id`. This is used for pagination to retrieve older messages.",
+            "description": "ID of the message before which to list messages.",
             "type": "integer"
           },
           "size": {
-            "description": "The number of messages to include in the results (defaults to 10).",
+            "description": "Number of messages to include in the results (defaults to 10).",
             "type": "integer"
           }
         },
@@ -65,41 +65,7 @@
         },
         "type": "object"
       },
-      "elephant.user.PollInboxMessagesRequest": {
-        "type": "object"
-      },
-      "elephant.user.PollInboxMessagesResponse": {
-        "properties": {
-          "created": {
-            "description": "Created timestamp is the RFC3339 timestamp for when the message was created.",
-            "type": "string"
-          },
-          "created_by": {
-            "description": "Creator of the message (application sub).",
-            "type": "string"
-          },
-          "id": {
-            "description": "ID of the message.",
-            "type": "integer"
-          },
-          "payload": {
-            "$ref": "#/components/schemas/newsdoc.Document"
-          },
-          "recipient": {
-            "description": "Recipient of the message (user sub).",
-            "type": "string"
-          },
-          "updated": {
-            "description": "Updated timestamp is the RFC3339 timestamp for when the message was last updated.",
-            "type": "string"
-          }
-        },
-        "type": "object"
-      },
-      "elephant.user.PollMessagesRequest": {
-        "type": "object"
-      },
-      "elephant.user.PollMessagesResponse": {
+      "elephant.user.Message": {
         "properties": {
           "created": {
             "description": "Created timestamp is the RFC3339 timestamp for when the message was created.",
@@ -139,6 +105,46 @@
         },
         "type": "object"
       },
+      "elephant.user.PollInboxMessagesRequest": {
+        "properties": {
+          "after_id": {
+            "description": "ID of the message after which to start returning messages.",
+            "type": "integer"
+          }
+        },
+        "type": "object"
+      },
+      "elephant.user.PollInboxMessagesResponse": {
+        "properties": {
+          "messages": {
+            "items": {
+              "$ref": "#/components/schemas/elephant.user.InboxMessage"
+            },
+            "type": "array"
+          }
+        },
+        "type": "object"
+      },
+      "elephant.user.PollMessagesRequest": {
+        "properties": {
+          "after_id": {
+            "description": "ID of the message after which to start returning messages.",
+            "type": "integer"
+          }
+        },
+        "type": "object"
+      },
+      "elephant.user.PollMessagesResponse": {
+        "properties": {
+          "messages": {
+            "items": {
+              "$ref": "#/components/schemas/elephant.user.Message"
+            },
+            "type": "array"
+          }
+        },
+        "type": "object"
+      },
       "elephant.user.PushInboxMessageRequest": {
         "properties": {
           "payload": {
@@ -345,7 +351,7 @@
   },
   "info": {
     "title": "user API",
-    "version": "v0.17.7"
+    "version": "v0.17.8"
   },
   "openapi": "3.0.0",
   "paths": {