Skip to content

Commit 5b7eeef

Browse files
renaming refactor
1 parent 2fd8cf5 commit 5b7eeef

File tree

4 files changed

+5423
-5441
lines changed

4 files changed

+5423
-5441
lines changed

hiro-openapi.yml

Lines changed: 165 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -1791,8 +1791,9 @@ paths:
17911791
/rpc/RPC_ID_LEADERBOARDS_CONFIG_GET?unwrap:
17921792
post:
17931793
summary: LEADERBOARDS_CONFIG_GET
1794-
description: "Get the leaderboards defined for the game."
1794+
description: "Deprecated: Use LEADERBOARD_LIST instead. Get the leaderboards defined for the game."
17951795
operationId: LEADERBOARDS_CONFIG_GET
1796+
deprecated: true
17961797
responses:
17971798
'200':
17981799
description: A successful response
@@ -1806,68 +1807,96 @@ paths:
18061807
application/json:
18071808
schema:
18081809
$ref: '#/components/schemas/Error'
1809-
/rpc/RPC_ID_LEADERBOARDS_WRITE_RECORD?unwrap:
1810+
/rpc/RPC_ID_LEADERBOARD_LIST?unwrap:
18101811
post:
1811-
summary: LEADERBOARDS_WRITE_RECORD
1812-
description: "Write a leaderboard record."
1813-
operationId: LEADERBOARDS_WRITE_RECORD
1812+
summary: LEADERBOARD_LIST
1813+
description: "List available leaderboards."
1814+
operationId: LEADERBOARD_LIST
1815+
requestBody:
1816+
required: false
1817+
content:
1818+
application/json:
1819+
schema:
1820+
$ref: '#/components/schemas/LeaderboardList'
1821+
responses:
1822+
'200':
1823+
description: A successful response
1824+
content:
1825+
application/json:
1826+
schema:
1827+
$ref: '#/components/schemas/Leaderboards'
1828+
'default':
1829+
description: An error response
1830+
content:
1831+
application/json:
1832+
schema:
1833+
$ref: '#/components/schemas/Error'
1834+
/rpc/RPC_ID_LEADERBOARD_GET?unwrap:
1835+
post:
1836+
summary: LEADERBOARD_GET
1837+
description: "Get a specified leaderboard with scores."
1838+
operationId: LEADERBOARD_GET
18141839
requestBody:
18151840
required: true
18161841
content:
18171842
application/json:
18181843
schema:
1819-
$ref: '#/components/schemas/WriteLeaderboardRecordRequest'
1844+
$ref: '#/components/schemas/LeaderboardGet'
18201845
responses:
18211846
'200':
18221847
description: A successful response
18231848
content:
18241849
application/json:
18251850
schema:
1826-
$ref: '#/components/schemas/LeaderboardRecord'
1851+
$ref: '#/components/schemas/Leaderboard'
18271852
'default':
18281853
description: An error response
18291854
content:
18301855
application/json:
18311856
schema:
18321857
$ref: '#/components/schemas/Error'
1833-
/rpc/RPC_ID_LEADERBOARDS_DELETE_RECORD?unwrap:
1858+
/rpc/RPC_ID_LEADERBOARD_UPDATE?unwrap:
18341859
post:
1835-
summary: LEADERBOARDS_DELETE_RECORD
1836-
description: "Delete the caller's leaderboard record."
1837-
operationId: LEADERBOARDS_DELETE_RECORD
1860+
summary: LEADERBOARD_UPDATE
1861+
description: "Update a leaderboard score."
1862+
operationId: LEADERBOARD_UPDATE
18381863
requestBody:
18391864
required: true
18401865
content:
18411866
application/json:
18421867
schema:
1843-
$ref: '#/components/schemas/DeleteLeaderboardRecordRequest'
1868+
$ref: '#/components/schemas/LeaderboardUpdate'
18441869
responses:
18451870
'200':
18461871
description: A successful response
1872+
content:
1873+
application/json:
1874+
schema:
1875+
$ref: '#/components/schemas/Leaderboard'
18471876
'default':
18481877
description: An error response
18491878
content:
18501879
application/json:
18511880
schema:
18521881
$ref: '#/components/schemas/Error'
1853-
/rpc/RPC_ID_LEADERBOARDS_LIST_RECORDS_AROUND_OWNER?unwrap:
1882+
/rpc/RPC_ID_LEADERBOARD_DELETE_SCORE?unwrap:
18541883
post:
1855-
summary: LEADERBOARDS_LIST_RECORDS_AROUND_OWNER
1856-
description: "List leaderboard records around the owner."
1857-
operationId: LEADERBOARDS_LIST_RECORDS_AROUND_OWNER
1884+
summary: LEADERBOARD_DELETE_SCORE
1885+
description: "Delete the caller's leaderboard score."
1886+
operationId: LEADERBOARD_DELETE_SCORE
18581887
requestBody:
18591888
required: true
18601889
content:
18611890
application/json:
18621891
schema:
1863-
$ref: '#/components/schemas/ListLeaderboardRecordsAroundOwnerRequest'
1892+
$ref: '#/components/schemas/LeaderboardDeleteScoreRequest'
18641893
responses:
18651894
'200':
18661895
description: A successful response
18671896
content:
18681897
application/json:
18691898
schema:
1870-
$ref: '#/components/schemas/LeaderboardRecordList'
1899+
$ref: '#/components/schemas/Leaderboard'
18711900
'default':
18721901
description: An error response
18731902
content:
@@ -2973,94 +3002,6 @@ components:
29733002
code:
29743003
type: integer
29753004
format: int32
2976-
WriteLeaderboardRecordRequest:
2977-
type: object
2978-
properties:
2979-
leaderboard_id:
2980-
type: string
2981-
record:
2982-
$ref: '#/components/schemas/LeaderboardRecordWrite'
2983-
LeaderboardRecordWrite:
2984-
type: object
2985-
properties:
2986-
score:
2987-
type: integer
2988-
format: int64
2989-
subscore:
2990-
type: integer
2991-
format: int64
2992-
metadata:
2993-
type: string
2994-
operator:
2995-
$ref: '#/components/schemas/Operator'
2996-
DeleteLeaderboardRecordRequest:
2997-
type: object
2998-
properties:
2999-
leaderboard_id:
3000-
type: string
3001-
ListLeaderboardRecordsAroundOwnerRequest:
3002-
type: object
3003-
properties:
3004-
leaderboard_id:
3005-
type: string
3006-
limit:
3007-
$ref: '#/components/schemas/GoogleProtobufUInt32value'
3008-
owner_id:
3009-
type: string
3010-
expiry:
3011-
$ref: '#/components/schemas/GoogleProtobufInt64value'
3012-
cursor:
3013-
type: string
3014-
LeaderboardRecord:
3015-
type: object
3016-
properties:
3017-
leaderboard_id:
3018-
type: string
3019-
owner_id:
3020-
type: string
3021-
username:
3022-
type: string
3023-
score:
3024-
type: integer
3025-
format: int64
3026-
subscore:
3027-
type: integer
3028-
format: int64
3029-
num_score:
3030-
type: integer
3031-
format: int32
3032-
metadata:
3033-
type: string
3034-
create_time:
3035-
$ref: '#/components/schemas/GoogleProtobufTimestamp'
3036-
update_time:
3037-
$ref: '#/components/schemas/GoogleProtobufTimestamp'
3038-
expiry_time:
3039-
$ref: '#/components/schemas/GoogleProtobufTimestamp'
3040-
rank:
3041-
type: integer
3042-
format: int64
3043-
max_num_score:
3044-
type: integer
3045-
format: int32
3046-
LeaderboardRecordList:
3047-
type: object
3048-
properties:
3049-
records:
3050-
type: array
3051-
items:
3052-
$ref: '#/components/schemas/LeaderboardRecord'
3053-
owner_records:
3054-
type: array
3055-
items:
3056-
$ref: '#/components/schemas/LeaderboardRecord'
3057-
next_cursor:
3058-
type: string
3059-
prev_cursor:
3060-
type: string
3061-
rank_count:
3062-
type: integer
3063-
format: int64
30643005
ProgressionCost:
30653006
type: object
30663007
properties:
@@ -5089,6 +5030,120 @@ components:
50895030
type: array
50905031
items:
50915032
$ref: '#/components/schemas/LeaderboardConfig'
5033+
LeaderboardScore:
5034+
type: object
5035+
properties:
5036+
id:
5037+
type: string
5038+
username:
5039+
type: string
5040+
display_name:
5041+
type: string
5042+
avatar_url:
5043+
type: string
5044+
create_time_sec:
5045+
type: integer
5046+
format: int64
5047+
update_time_sec:
5048+
type: integer
5049+
format: int64
5050+
rank:
5051+
type: integer
5052+
format: int64
5053+
score:
5054+
type: integer
5055+
format: int64
5056+
subscore:
5057+
type: integer
5058+
format: int64
5059+
num_scores:
5060+
type: integer
5061+
format: int64
5062+
metadata:
5063+
type: string
5064+
Leaderboard:
5065+
type: object
5066+
properties:
5067+
id:
5068+
type: string
5069+
ascending:
5070+
type: boolean
5071+
operator:
5072+
type: string
5073+
reset_schedule:
5074+
type: string
5075+
authoritative:
5076+
type: boolean
5077+
additional_properties:
5078+
type: object
5079+
additionalProperties:
5080+
type: string
5081+
scores:
5082+
type: array
5083+
items:
5084+
$ref: '#/components/schemas/LeaderboardScore'
5085+
owner_scores:
5086+
type: array
5087+
items:
5088+
$ref: '#/components/schemas/LeaderboardScore'
5089+
next_cursor:
5090+
type: string
5091+
prev_cursor:
5092+
type: string
5093+
rank_count:
5094+
type: integer
5095+
format: int64
5096+
current_time_sec:
5097+
type: integer
5098+
format: int64
5099+
regions:
5100+
type: array
5101+
items:
5102+
type: string
5103+
Leaderboards:
5104+
type: object
5105+
properties:
5106+
leaderboards:
5107+
type: array
5108+
items:
5109+
$ref: '#/components/schemas/Leaderboard'
5110+
LeaderboardList:
5111+
type: object
5112+
properties:
5113+
with_scores:
5114+
type: boolean
5115+
LeaderboardGet:
5116+
type: object
5117+
properties:
5118+
id:
5119+
type: string
5120+
owner_id:
5121+
type: string
5122+
limit:
5123+
type: integer
5124+
format: int32
5125+
cursor:
5126+
type: string
5127+
LeaderboardUpdate:
5128+
type: object
5129+
properties:
5130+
id:
5131+
type: string
5132+
score:
5133+
type: integer
5134+
format: int64
5135+
subscore:
5136+
type: integer
5137+
format: int64
5138+
metadata:
5139+
type: string
5140+
conditional_metadata_update:
5141+
type: boolean
5142+
LeaderboardDeleteScoreRequest:
5143+
type: object
5144+
properties:
5145+
id:
5146+
type: string
50925147
Tutorial:
50935148
type: object
50945149
properties:
@@ -6671,9 +6726,10 @@ components:
66716726
- RPC_ID_BASE_SET_DEVICE_PREFS
66726727
- RPC_ID_BASE_SYNC
66736728
- RPC_ID_LEADERBOARDS_CONFIG_GET
6674-
- RPC_ID_LEADERBOARDS_WRITE_RECORD
6675-
- RPC_ID_LEADERBOARDS_DELETE_RECORD
6676-
- RPC_ID_LEADERBOARDS_LIST_RECORDS_AROUND_OWNER
6729+
- RPC_ID_LEADERBOARD_LIST
6730+
- RPC_ID_LEADERBOARD_GET
6731+
- RPC_ID_LEADERBOARD_UPDATE
6732+
- RPC_ID_LEADERBOARD_DELETE_SCORE
66776733
- RPC_ID_EVENT_LEADERBOARD_LIST
66786734
- RPC_ID_EVENT_LEADERBOARD_GET
66796735
- RPC_ID_EVENT_LEADERBOARD_UPDATE
@@ -6728,14 +6784,6 @@ components:
67286784
- RPC_SOCKET_ID_UNSPECIFIED
67296785
- RPC_SOCKET_ID_AUCTIONS_FOLLOW
67306786
- RPC_SOCKET_ID_AUCTIONS_BID
6731-
Operator:
6732-
type: string
6733-
enum:
6734-
- NO_OVERRIDE
6735-
- BEST
6736-
- SET
6737-
- INCREMENT
6738-
- DECREMENT
67396787
ProgressionPreconditionsOperator:
67406788
type: string
67416789
enum:

0 commit comments

Comments
 (0)