@@ -9,31 +9,35 @@ servers:
99- description : Development server
1010 url : http://localhost:8080/api/v1
1111tags :
12- - description : Operations related to user complexes
12+ - description : コンプレックスに関する操作
1313 name : Complexes
14- - description : Operations related to user goals
14+ - description : 目標に関する操作
1515 name : Goals
16- - description : Operations related to user actions
16+ - description : 行動に関する操作
1717 name : Actions
18- - description : Operations related to badges
18+ - description : バッジに関する操作
1919 name : Badges
20- - description : API health check
20+ - description : ユーザーが獲得したバッジに関する操作
21+ name : UserBadges
22+ - description : APIのヘルスチェック
2123 name : Health
2224paths :
2325 /ping :
2426 get :
27+ operationId : ping
2528 responses :
2629 " 200 " :
2730 content :
2831 application/json :
2932 schema :
30- $ref : ' #/components/schemas/_ping_get_200_response '
33+ $ref : ' #/components/schemas/ping_200_response '
3134 description : Success response
3235 summary : サーバーの死活監視
3336 tags :
3437 - Health
3538 /complexes :
3639 get :
40+ operationId : getComplexes
3741 responses :
3842 " 200 " :
3943 content :
6165 tags :
6266 - Complexes
6367 post :
68+ operationId : createComplex
6469 requestBody :
6570 content :
6671 application/json :
9398 - Complexes
9499 /complexes/{complexId} :
95100 delete :
101+ operationId : deleteComplex
96102 parameters :
97103 - description : 操作対象のコンプレックスID
98104 explode : false
@@ -125,6 +131,7 @@ paths:
125131 tags :
126132 - Complexes
127133 get :
134+ operationId : getComplex
128135 parameters :
129136 - description : 操作対象のコンプレックスID
130137 explode : false
@@ -172,6 +179,7 @@ paths:
172179 type : integer
173180 style : simple
174181 put :
182+ operationId : updateComplex
175183 parameters :
176184 - description : 操作対象のコンプレックスID
177185 explode : false
@@ -221,6 +229,7 @@ paths:
221229 - Complexes
222230 /goals :
223231 get :
232+ operationId : getGoals
224233 responses :
225234 " 200 " :
226235 content :
@@ -248,6 +257,7 @@ paths:
248257 tags :
249258 - Goals
250259 post :
260+ operationId : createGoal
251261 requestBody :
252262 content :
253263 application/json :
@@ -286,6 +296,7 @@ paths:
286296 - Goals
287297 /goals/{goalId} :
288298 delete :
299+ operationId : deleteGoal
289300 parameters :
290301 - description : 操作対象の目標ID
291302 explode : false
@@ -316,6 +327,7 @@ paths:
316327 tags :
317328 - Goals
318329 get :
330+ operationId : getGoal
319331 parameters :
320332 - description : 操作対象の目標ID
321333 explode : false
@@ -361,6 +373,7 @@ paths:
361373 type : integer
362374 style : simple
363375 put :
376+ operationId : updateGoal
364377 parameters :
365378 - description : 操作対象の目標ID
366379 explode : false
@@ -408,6 +421,7 @@ paths:
408421 - Goals
409422 /actions :
410423 get :
424+ operationId : getActions
411425 parameters :
412426 - description : 行動を取得する対象の目標ID
413427 explode : true
@@ -454,6 +468,7 @@ paths:
454468 tags :
455469 - Actions
456470 post :
471+ operationId : createAction
457472 requestBody :
458473 content :
459474 application/json :
@@ -480,6 +495,7 @@ paths:
480495 - Actions
481496 /actions/{actionId} :
482497 delete :
498+ operationId : deleteAction
483499 parameters :
484500 - description : 操作対象の行動ID
485501 explode : false
@@ -517,6 +533,7 @@ paths:
517533 type : integer
518534 style : simple
519535 put :
536+ operationId : updateAction
520537 parameters :
521538 - description : 操作対象の行動ID
522539 explode : false
@@ -564,6 +581,7 @@ paths:
564581 - Actions
565582 /badges :
566583 get :
584+ operationId : getBadges
567585 responses :
568586 " 200 " :
569587 content :
@@ -586,6 +604,7 @@ paths:
586604 - Badges
587605 /me/badges :
588606 get :
607+ operationId : getUserBadges
589608 responses :
590609 " 200 " :
591610 content :
@@ -1090,7 +1109,7 @@ components:
10901109 - achieved_at
10911110 - badge
10921111 - user_id
1093- _ping_get_200_response :
1112+ ping_200_response :
10941113 example :
10951114 message : pong
10961115 properties :
0 commit comments