Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

空配列の扱いを OpenAPI に追記 #24

Merged
merged 1 commit into from
Jan 7, 2025
+8 −6
Merged

空配列の扱いを OpenAPI に追記 #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions openapi/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ paths:
get:
tags: ["teams"]
summary: "チーム一覧取得"
description: "チーム一覧を取得します"
description: "チーム一覧を取得します (0件の場合も200で空配列が返ります)"
operationId: "getTeams"
security:
- UserAuth: []
Expand Down Expand Up @@ -253,7 +253,7 @@ paths:
get:
tags: ["instance"]
summary: "インスタンス一覧取得"
description: "チームに所属しているインスタンス一覧を取得します"
description: "チームに所属しているインスタンス一覧を取得します (0件の場合も200で空配列が返ります)"
operationId: "getTeamInstances"
security:
- TeamAuth: []
Expand Down Expand Up @@ -377,7 +377,7 @@ paths:
get:
tags: ["instance"]
summary: "インスタンス一覧取得"
description: "全インスタンス一覧を取得します"
description: "全インスタンス一覧を取得します (0件の場合も200で空配列が返ります)"
operationId: "getInstances"
security:
- AdminAuth: []
Expand Down Expand Up @@ -431,7 +431,7 @@ paths:
get:
tags: ["benchmark"]
summary: "ベンチマーク一覧取得"
description: "全チームのベンチマーク一覧を取得します"
description: "全チームのベンチマーク一覧を取得します (0件の場合も200で空配列が返ります)"
operationId: "getBenchmarks"
security:
- AdminAuth: []
Expand Down Expand Up @@ -460,6 +460,7 @@ paths:
description: |
ベンチマーク待ちのキューを取得します。
createdAtの昇順になっており、現在実行中のベンチマークと、実行待ちのベンチマークが含まれます。
0件の場合も200で空配列が返ります。
operationId: "getBenchmarkQueue"
security:
- UserAuth: []
Expand All @@ -481,7 +482,7 @@ paths:
get:
tags: ["benchmark"]
summary: "チームのベンチマーク一覧取得"
description: "チームのベンチマーク一覧を取得します"
description: "チームのベンチマーク一覧を取得します (0件の場合も200で空配列が返ります)"
operationId: "getTeamBenchmarks"
security:
- TeamAuth: []
Expand Down Expand Up @@ -567,7 +568,7 @@ paths:
get:
tags: ["score"]
summary: "全てのスコア取得"
description: "全てのベンチマークのスコアをチームごとに取得します"
description: "全てのベンチマークのスコアをチームごとに取得します (0件の場合も200で空配列が返ります)"
operationId: "getScores"
security:
- UserAuth: []
Expand All @@ -592,6 +593,7 @@ paths:
description: |
ベンチマークのスコアランキングを取得します。1位から順に並んでいます。
同じスコアの場合は、ベンチマーク実行日時(createdAt)が早い順に並べます。
0件の場合も200で空配列が返ります
operationId: "getRanking"
security:
- UserAuth: []
Expand Down
Loading