update

Author: andresfelipemendez

hiro-openapi.yml

@@ -1269,7 +1269,7 @@ paths:
   /rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_UPDATE?unwrap:
     post:
       summary: TEAMS_EVENT_LEADERBOARD_UPDATE
-      description: "Update an event leaderboard record for a user."
+      description: "Update an event leaderboard score for a user."
       operationId: TEAMS_EVENT_LEADERBOARD_UPDATE
       requestBody:
         required: true
@@ -1791,9 +1791,8 @@ paths:
   /rpc/RPC_ID_LEADERBOARDS_CONFIG_GET?unwrap:
     post:
       summary: LEADERBOARDS_CONFIG_GET
-      description: "Deprecated: Use LEADERBOARD_LIST instead. Get the leaderboards defined for the game."
+      description: "Deprecated: Use RPC_ID_LEADERBOARD_LIST instead. List available leaderboards."
       operationId: LEADERBOARDS_CONFIG_GET
-      deprecated: true
       responses:
         '200':
           description: A successful response
@@ -1813,7 +1812,7 @@ paths:
       description: "List available leaderboards."
       operationId: LEADERBOARD_LIST
       requestBody:
-        required: false
+        required: true
         content:
           application/json:
             schema:
@@ -1930,7 +1929,7 @@ paths:
   /rpc/RPC_ID_EVENT_LEADERBOARD_UPDATE?unwrap:
     post:
       summary: EVENT_LEADERBOARD_UPDATE
-      description: "Update an event leaderboard record for a user."
+      description: "Update an event leaderboard score for a user."
       operationId: EVENT_LEADERBOARD_UPDATE
       requestBody:
         required: true
@@ -2978,6 +2977,141 @@ components:
         code:
           type: integer
           format: int32
+    LeaderboardList:
+      type: object
+      properties:
+        with_scores:
+          type: boolean
+    LeaderboardUpdate:
+      type: object
+      properties:
+        id:
+          type: string
+        score:
+          type: integer
+          format: int64
+        subscore:
+          type: integer
+          format: int64
+        metadata:
+          type: string
+        conditional_metadata_update:
+          type: boolean
+    LeaderboardGet:
+      type: object
+      properties:
+        id:
+          type: string
+        player_ids:
+          type: array
+          items:
+            type: string
+        limit:
+          type: integer
+          format: int32
+        cursor:
+          type: string
+    LeaderboardScore:
+      type: object
+      properties:
+        id:
+          type: string
+        username:
+          type: string
+        display_name:
+          type: string
+        avatar_url:
+          type: string
+        create_time_sec:
+          type: integer
+          format: int64
+        update_time_sec:
+          type: integer
+          format: int64
+        rank:
+          type: integer
+          format: int64
+        score:
+          type: integer
+          format: int64
+        subscore:
+          type: integer
+          format: int64
+        num_scores:
+          type: integer
+          format: int64
+        metadata:
+          type: string
+    Leaderboard:
+      type: object
+      properties:
+        id:
+          type: string
+        ascending:
+          type: boolean
+        operator:
+          type: string
+        reset_schedule:
+          type: string
+        authoritative:
+          type: boolean
+        scores:
+          type: array
+          items:
+            $ref: '#/components/schemas/LeaderboardScore'
+        owner_scores:
+          type: array
+          items:
+            $ref: '#/components/schemas/LeaderboardScore'
+        next_cursor:
+          type: string
+        prev_cursor:
+          type: string
+        rank_count:
+          type: integer
+          format: int64
+        current_time_sec:
+          type: integer
+          format: int64
+        regions:
+          type: array
+          items:
+            type: string
+        additionalProperties:
+          type: object
+          additionalProperties:
+            type: string
+    Leaderboards:
+      type: object
+      properties:
+        leaderboards:
+          type: array
+          items:
+            $ref: '#/components/schemas/Leaderboard'
+    LeaderboardConfig:
+      type: object
+      properties:
+        id:
+          type: string
+        sort_order:
+          type: string
+        operator:
+          type: string
+        reset_schedule:
+          type: string
+        authoritative:
+          type: boolean
+        regions:
+          type: array
+          items:
+            type: string
+    LeaderboardConfigList:
+      type: object
+      properties:
+        leaderboard_configs:
+          type: array
+          items:
+            $ref: '#/components/schemas/LeaderboardConfig'
     ProgressionCost:
       type: object
       properties:
@@ -3720,6 +3854,9 @@ components:
             type: string
         open:
           type: boolean
+        max_scores:
+          type: integer
+          format: int64
         start_delay_sec:
           type: integer
           format: int64
@@ -4979,139 +5116,6 @@ components:
     EnergySpendWithRefillStartTimeRequest:
       type: object
       properties:
-    LeaderboardConfig:
-      type: object
-      properties:
-        id:
-          type: string
-        sort_order:
-          type: string
-        operator:
-          type: string
-        reset_schedule:
-          type: string
-        authoritative:
-          type: boolean
-        regions:
-          type: array
-          items:
-            type: string
-    LeaderboardConfigList:
-      type: object
-      properties:
-        leaderboard_configs:
-          type: array
-          items:
-            $ref: '#/components/schemas/LeaderboardConfig'
-    LeaderboardScore:
-      type: object
-      properties:
-        id:
-          type: string
-        username:
-          type: string
-        display_name:
-          type: string
-        avatar_url:
-          type: string
-        create_time_sec:
-          type: integer
-          format: int64
-        update_time_sec:
-          type: integer
-          format: int64
-        rank:
-          type: integer
-          format: int64
-        score:
-          type: integer
-          format: int64
-        subscore:
-          type: integer
-          format: int64
-        num_scores:
-          type: integer
-          format: int64
-        metadata:
-          type: string
-    Leaderboard:
-      type: object
-      properties:
-        id:
-          type: string
-        sort_order:
-          type: string
-        operator:
-          type: string
-        reset_schedule:
-          type: string
-        authoritative:
-          type: boolean
-        additional_properties:
-          type: object
-          additionalProperties:
-            type: string
-        scores:
-          type: array
-          items:
-            $ref: '#/components/schemas/LeaderboardScore'
-        owner_scores:
-          type: array
-          items:
-            $ref: '#/components/schemas/LeaderboardScore'
-        next_cursor:
-          type: string
-        prev_cursor:
-          type: string
-        rank_count:
-          type: integer
-          format: int64
-        current_time_sec:
-          type: integer
-          format: int64
-        regions:
-          type: array
-          items:
-            type: string
-    Leaderboards:
-      type: object
-      properties:
-        leaderboards:
-          type: array
-          items:
-            $ref: '#/components/schemas/Leaderboard'
-    LeaderboardList:
-      type: object
-      properties:
-        with_scores:
-          type: boolean
-    LeaderboardGet:
-      type: object
-      properties:
-        id:
-          type: string
-        owner_id:
-          type: string
-        limit:
-          type: integer
-          format: int32
-        cursor:
-          type: string
-    LeaderboardUpdate:
-      type: object
-      properties:
-        id:
-          type: string
-        score:
-          type: integer
-          format: int64
-        subscore:
-          type: integer
-          format: int64
-        metadata:
-          type: string
-        conditional_metadata_update:
-          type: boolean
     Tutorial:
       type: object
       properties:
@@ -6051,6 +6055,8 @@ components:
           type: string
         metadata:
           type: string
+        claim_reward:
+          type: boolean
     TeamEventLeaderboardScore:
       type: object
       properties:

hiro.proto

@@ -352,8 +352,8 @@ message LeaderboardUpdate {
 message LeaderboardGet {
   // Leaderboard ID to get.
   string id = 1;
-  // Owner ID to get scores around.
-  string owner_id = 2;
+  // Player IDs to include scores for.
+  repeated string player_ids = 2;
   // Limit.
   int32 limit = 3;
   // Cursor.