Skip to content

Commit

Permalink
Merge pull request #119 from GiganticMinecraft/addTags
Browse files Browse the repository at this point in the history
formに関連するAPIにformsタグをつける
  • Loading branch information
Lucky authored Oct 31, 2023
2 parents c28ee3f + 61bba3b commit 1de265b
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 0 deletions.
4 changes: 4 additions & 0 deletions schema/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ components:
security:
- Bearer: []

tags:
- name: forms
description: フォーム操作に関連するAPI

paths:
/forms:
$ref: "./paths/forms/index.yml"
Expand Down
2 changes: 2 additions & 0 deletions schema/paths/forms/[formId]/answers/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
get:
tags:
- forms
operationId: getFormAnswers
summary: 指定したフォームのすべての回答を取得する
parameters:
Expand Down
6 changes: 6 additions & 0 deletions schema/paths/forms/[formId]/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
get:
tags:
- forms
operationId: getForm
summary: フォームの詳細を取得する
parameters:
Expand All @@ -20,6 +22,8 @@ get:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

delete:
tags:
- forms
operationId: deleteForm
summary: フォームを削除する
parameters:
Expand All @@ -43,6 +47,8 @@ delete:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

patch:
tags:
- forms
operationId: updateForm
summary: フォームの値を更新する
parameters:
Expand Down
2 changes: 2 additions & 0 deletions schema/paths/forms/[formId]/questions/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
get:
tags:
- forms
operationId: getQuestions
summary: 質問の取得
description: 指定したフォームの質問をすべて取得します。
Expand Down
6 changes: 6 additions & 0 deletions schema/paths/forms/answers/comment/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
post:
tags:
- forms
operationId: addComment
summary: 回答に対してコメントを残す
requestBody:
Expand All @@ -21,6 +23,8 @@ post:
$ref: "../../../../errors/errorResponses.yml#/components/responses/internalServerError"

delete:
tags:
- forms
operationId: deleteComment
summary: コメントを削除する
requestBody:
Expand All @@ -45,6 +49,8 @@ delete:
$ref: "../../../../errors/errorResponses.yml#/components/responses/internalServerError"

patch:
tags:
- forms
operationId: editComment
summary: コメントを編集する
requestBody:
Expand Down
4 changes: 4 additions & 0 deletions schema/paths/forms/answers/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
get:
tags:
- forms
operationId: getAllAnswers
summary: フォームの回答をすべて取得する
responses:
Expand All @@ -20,6 +22,8 @@ get:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

post:
tags:
- forms
operationId: postFormAnswers
summary: 指定フォームに対して回答する
requestBody:
Expand Down
4 changes: 4 additions & 0 deletions schema/paths/forms/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
post:
tags:
- forms
operationId: createForm
summary: フォームの新規作成
description: |
Expand Down Expand Up @@ -33,6 +35,8 @@ post:
"500":
$ref: "../../errors/errorResponses.yml#/components/responses/internalServerError"
get:
tags:
- forms
operationId: listForms
summary: フォームの一覧を取得する
description: |
Expand Down
6 changes: 6 additions & 0 deletions schema/paths/forms/labels/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
get:
tags:
- forms
operationId: getFormLabels
summary: 指定した種類のラベルをすべて取得する
description: 指定されたものに対してつけられるラベルをすべて取得する
Expand All @@ -19,6 +21,8 @@ get:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

post:
tags:
- forms
operationId: createFormLabel
summary: ラベルを作成する
description: ラベルを新規作成する
Expand All @@ -42,6 +46,8 @@ post:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

delete:
tags:
- forms
operationId: deleteFormLabel
summary: ラベルを削除する
description: 作成済みのラベルを削除する
Expand Down
4 changes: 4 additions & 0 deletions schema/paths/forms/questions/index.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
post:
tags:
- forms
operationId: createQuestion
summary: 質問の新規作成
description: |
Expand Down Expand Up @@ -27,6 +29,8 @@ post:
$ref: "../../../errors/errorResponses.yml#/components/responses/internalServerError"

delete:
tags:
- forms
operationId: deleteQuestion
summary: 質問を削除する
description: 作成済みの質問を削除する
Expand Down

0 comments on commit 1de265b

Please sign in to comment.