Add storage index create indexOnly flag (#1080)

Fix storage index listing result ordering.
heroiclabs · Oct 10, 2023 · 31c380b · 31c380b
1 parent 5c21327
commit 31c380b
Show file tree

Hide file tree

Showing 28 changed files with 2,539 additions and 1,836 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,12 @@ The format is based on [keep a changelog](http://keepachangelog.com) and this pr
 - Use Steam partner API instead of public API for Steam profiles and friends requests.
 
 ### Fixed
-- Fixed multiple issues found by linter.
+- Fix linter-found test issue.
+- Fix storage index listing results sometimes being returned with incorrect order.
+
+### Changed
+- Add create_time and update_time to returned storage engine writes acks.
+- Add storage index create flag to read only from the index.
 
 ### Fixed
 - Fixes calculation of leaderboard and tournament times for rare types of CRON expressions that don't execute at a fixed interval.

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
@@ -857,7 +857,7 @@
         "parameters": [
           {
             "name": "body",
-            "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.",
+            "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.\n\nhttps://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign",
             "in": "body",
             "required": true,
             "schema": {
@@ -1211,7 +1211,7 @@
         "parameters": [
           {
             "name": "body",
-            "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.",
+            "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.\n\nhttps://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign",
             "in": "body",
             "required": true,
             "schema": {
@@ -1819,7 +1819,30 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/apiUpdateGroupRequest"
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "Name."
+                },
+                "description": {
+                  "type": "string",
+                  "description": "Description string."
+                },
+                "langTag": {
+                  "type": "string",
+                  "description": "Lang tag."
+                },
+                "avatarUrl": {
+                  "type": "string",
+                  "description": "Avatar URL."
+                },
+                "open": {
+                  "type": "boolean",
+                  "description": "Open is true if anyone should be allowed to join, or false if joins must be approved by a group admin."
+                }
+              },
+              "description": "Update fields in a given group."
             }
           }
         ],
@@ -2697,7 +2720,7 @@
           },
           {
             "name": "cacheableCursor",
-            "description": "A cursor to page through notifications. May be cached by clients to get from point in time forwards.",
+            "description": "A cursor to page through notifications. May be cached by clients to get from point in time forwards.\n\nvalue from NotificationList.cacheable_cursor.",
             "in": "query",
             "required": false,
             "type": "string"
@@ -3026,7 +3049,7 @@
           },
           {
             "name": "cursor",
-            "description": "The cursor to page through results from.",
+            "description": "The cursor to page through results from.\n\nvalue from StorageObjectList.cursor.",
             "in": "query",
             "required": false,
             "type": "string"
@@ -3080,7 +3103,7 @@
           },
           {
             "name": "cursor",
-            "description": "The cursor to page through results from.",
+            "description": "The cursor to page through results from.\n\nvalue from StorageObjectList.cursor.",
             "in": "query",
             "required": false,
             "type": "string"
@@ -3644,6 +3667,7 @@
         "devices": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiAccountDevice"
           },
           "description": "The devices which belong to the user's account."
@@ -3725,7 +3749,7 @@
         },
         "password": {
           "type": "string",
-          "description": "A password for the user account."
+          "description": "A password for the user account.\n\nIgnored with unlink operations."
         },
         "vars": {
           "type": "object",
@@ -3807,7 +3831,7 @@
           "description": "Extra information that will be bundled in the session token."
         }
       },
-      "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink."
+      "description": "Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.\n\nhttps://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign"
     },
     "apiAccountGoogle": {
       "type": "object",
@@ -3910,6 +3934,7 @@
         "messages": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiChannelMessage"
           },
           "description": "A list of messages."
@@ -3984,6 +4009,7 @@
         "objectIds": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiDeleteStorageObjectId"
           },
           "description": "Batch of storage objects."
@@ -4027,7 +4053,7 @@
         "state": {
           "type": "integer",
           "format": "int32",
-          "description": "The friend status."
+          "description": "The friend status.\n\none of \"Friend.State\"."
         },
         "updateTime": {
           "type": "string",
@@ -4043,6 +4069,7 @@
         "friends": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiFriend"
           },
           "description": "The Friend objects."
@@ -4118,6 +4145,7 @@
         "groups": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiGroup"
           },
           "description": "One or more groups."
@@ -4135,6 +4163,7 @@
         "groupUsers": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/GroupUserListGroupUser"
           },
           "description": "User-role pairs for a group."
@@ -4214,13 +4243,15 @@
         "records": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiLeaderboardRecord"
           },
           "description": "A list of leaderboard records."
         },
         "ownerRecords": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiLeaderboardRecord"
           },
           "description": "A batched set of leaderboard records belonging to specified owners."
@@ -4308,6 +4339,7 @@
         "matches": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiMatch"
           },
           "description": "A number of matches corresponding to a list operation."
@@ -4357,6 +4389,7 @@
         "notifications": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiNotification"
           },
           "description": "Collection of notifications."
@@ -4404,6 +4437,7 @@
         "objectIds": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiReadStorageObjectId"
           },
           "description": "Batch of storage objects."
@@ -4542,6 +4576,16 @@
         "userId": {
           "type": "string",
           "description": "The owner of the object."
+        },
+        "createTime": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created."
+        },
+        "updateTime": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated."
         }
       },
       "description": "A storage acknowledgement."
@@ -4552,6 +4596,7 @@
         "acks": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiStorageObjectAck"
           },
           "description": "Batch of storage write acknowledgements."
@@ -4565,6 +4610,7 @@
         "objects": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiStorageObject"
           },
           "description": "The list of storage objects."
@@ -4582,6 +4628,7 @@
         "objects": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiStorageObject"
           },
           "description": "The batch of storage objects."
@@ -4617,6 +4664,7 @@
         "validatedSubscriptions": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiValidatedSubscription"
           },
           "description": "Stored validated subscriptions."
@@ -4737,6 +4785,7 @@
         "tournaments": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiTournament"
           },
           "description": "The list of tournaments returned."
@@ -4754,13 +4803,15 @@
         "records": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiLeaderboardRecord"
           },
           "description": "A list of tournament records."
         },
         "ownerRecords": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiLeaderboardRecord"
           },
           "description": "A batched set of tournament records belonging to specified owners."
@@ -4811,36 +4862,6 @@
       },
       "description": "Update a user's account details."
     },
-    "apiUpdateGroupRequest": {
-      "type": "object",
-      "properties": {
-        "groupId": {
-          "type": "string",
-          "description": "The ID of the group to update."
-        },
-        "name": {
-          "type": "string",
-          "description": "Name."
-        },
-        "description": {
-          "type": "string",
-          "description": "Description string."
-        },
-        "langTag": {
-          "type": "string",
-          "description": "Lang tag."
-        },
-        "avatarUrl": {
-          "type": "string",
-          "description": "Avatar URL."
-        },
-        "open": {
-          "type": "boolean",
-          "description": "Open is true if anyone should be allowed to join, or false if joins must be approved by a group admin."
-        }
-      },
-      "description": "Update fields in a given group."
-    },
     "apiUser": {
       "type": "object",
       "properties": {
@@ -4928,6 +4949,7 @@
         "userGroups": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/UserGroupListUserGroup"
           },
           "description": "Group-role pairs for a user."
@@ -4945,6 +4967,7 @@
         "users": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiUser"
           },
           "description": "The User objects."
@@ -5004,6 +5027,7 @@
         "validatedPurchases": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiValidatedPurchase"
           },
           "description": "Newly seen validated purchases."
@@ -5181,7 +5205,7 @@
         },
         "version": {
           "type": "string",
-          "description": "The version hash of the object to check. Possible values are: [\"\", \"*\", \"#hash#\"]."
+          "description": "The version hash of the object to check. Possible values are: [\"\", \"*\", \"#hash#\"].\n\nif-match and if-none-match"
         },
         "permissionRead": {
           "type": "integer",
@@ -5202,6 +5226,7 @@
         "objects": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/apiWriteStorageObject"
           },
           "description": "The objects to store on the server."
@@ -5212,14 +5237,11 @@
     "protobufAny": {
       "type": "object",
       "properties": {
-        "typeUrl": {
+        "@type": {
           "type": "string"
-        },
-        "value": {
-          "type": "string",
-          "format": "byte"
         }
-      }
+      },
+      "additionalProperties": {}
     },
     "rpcStatus": {
       "type": "object",
@@ -5234,6 +5256,7 @@
         "details": {
           "type": "array",
           "items": {
+            "type": "object",
             "$ref": "#/definitions/protobufAny"
           }
         }