Skip to content

Commit 9453d25

Browse files
committed
Merge branch 'docs/openapi-ranking-endpoints' of https://github.com/su-its/typing into docs/openapi-ranking-endpoints
2 parents 6b3841a + 9db2d12 commit 9453d25

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

typing-app/src/libs/api/v1.d.ts

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ export interface paths {
2121
/** スコアを登録 */
2222
post: operations["registerScore"];
2323
};
24+
"/scores/{user-id}/current-rank": {
25+
/** ユーザーの現在の順位を取得 */
26+
get: operations["getMyscoreRanking"];
27+
};
2428
}
2529

2630
export type webhooks = Record<string, never>;
@@ -109,7 +113,11 @@ export interface operations {
109113
/** @description スコアランキングを返します。 */
110114
200: {
111115
content: {
112-
"application/json": components["schemas"]["ScoreRanking"][];
116+
"application/json": {
117+
rankings?: components["schemas"]["ScoreRanking"][];
118+
/** @description ランキングの全件数 */
119+
total_count?: number;
120+
};
113121
};
114122
};
115123
/** @description 不正なリクエストです。 */
@@ -149,4 +157,32 @@ export interface operations {
149157
};
150158
};
151159
};
160+
/** ユーザーの現在の順位を取得 */
161+
getMyscoreRanking: {
162+
parameters: {
163+
path: {
164+
/** @description ユーザーID */
165+
"user-id": string;
166+
};
167+
};
168+
responses: {
169+
/** @description ユーザーの現在の順位を返します。 */
170+
200: {
171+
content: {
172+
"application/json": {
173+
/** @description ユーザーの現在の順位 */
174+
"current-rank"?: number;
175+
};
176+
};
177+
};
178+
/** @description ユーザーが見つかりません。 */
179+
404: {
180+
content: never;
181+
};
182+
/** @description サーバーエラーが発生しました。 */
183+
500: {
184+
content: never;
185+
};
186+
};
187+
};
152188
}

0 commit comments

Comments
 (0)