Skip to content

Commit 6a8c4fb

Browse files
committed
Added GET /actions api definition into openapi.yaml
1 parent e27d382 commit 6a8c4fb

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

openapi.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -622,6 +622,50 @@ paths:
622622
schema:
623623
$ref: "#/components/schemas/Error"
624624
# GET /actions は要件に応じてフィルタリングパラメータ(例: goal_id, user_id, date_range)を追加検討
625+
get:
626+
summary: 指定された目標IDに紐づく行動の一覧を取得
627+
tags:
628+
- Actions
629+
security:
630+
- BearerAuth: []
631+
parameters:
632+
- name: goal_id
633+
in: query
634+
required: true
635+
description: 行動を取得する対象の目標ID
636+
schema:
637+
type: integer
638+
format: int64
639+
example: 1
640+
responses:
641+
"200":
642+
description: 行動一覧の取得成功
643+
content:
644+
application/json:
645+
schema:
646+
type: array
647+
items:
648+
$ref: "#/components/schemas/Action"
649+
"400":
650+
description: リクエスト不正 (goal_idが指定されていない、または無効など)
651+
content:
652+
application/json:
653+
schema:
654+
$ref: "#/components/schemas/Error"
655+
"401":
656+
description: 認証エラー
657+
content:
658+
application/json:
659+
schema:
660+
$ref: "#/components/schemas/Error"
661+
"404":
662+
description: 指定された目標が見つからない、またはその目標に紐づく行動が存在しない
663+
"500":
664+
description: サーバー内部エラー
665+
content:
666+
application/json:
667+
schema:
668+
$ref: "#/components/schemas/Error"
625669

626670
/badges:
627671
get:

0 commit comments

Comments
 (0)