Add cacheable cursor to channel message listings.

heroiclabs · Nov 28, 2020 · 762bee9 · 762bee9
1 parent 51715c8
commit 762bee9
Show file tree

Hide file tree

Showing 12 changed files with 1,130 additions and 1,068 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,9 @@ All notable changes to this project are documented below.
 The format is based on [keep a changelog](http://keepachangelog.com) and this project uses [semantic versioning](http://semver.org).
 
 ## [Unreleased]
+### Added
+- Add cacheable cursor to channel message listings.
+
 ### Changed
 - Make metrics prefix configurable, default to fixed value.
 - Build with Go 1.15.5 release.

diff --git a/apigrpc/apigrpc.pb.go b/apigrpc/apigrpc.pb.go
diff --git a/apigrpc/apigrpc.pb.gw.go b/apigrpc/apigrpc.pb.gw.go
diff --git a/apigrpc/apigrpc.swagger.json b/apigrpc/apigrpc.swagger.json
@@ -3351,11 +3351,15 @@
         },
         "nextCursor": {
           "type": "string",
-          "description": "The cursor to send when retireving the next page, if any."
+          "description": "The cursor to send when retrieving the next page, if any."
         },
         "prevCursor": {
           "type": "string",
           "description": "The cursor to send when retrieving the previous page, if any."
+        },
+        "cacheableCursor": {
+          "type": "string",
+          "description": "Cacheable cursor to list newer messages. Durable and designed to be stored, unlike next/prev cursors."
         }
       },
       "description": "A list of channel messages, usually a result of a list operation."