Merge pull request #92 from GiganticMinecraft/addFormPatch

formの情報を更新できるエントリポイントを生やす
GiganticMinecraft · Jun 21, 2023 · bf2996e · bf2996e
2 parents b3f7bda + 9cf9101
commit bf2996e
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 8 deletions.
diff --git a/schema/paths/forms/specifyForm/index.yml b/schema/paths/forms/specifyForm/index.yml
@@ -40,3 +40,27 @@ delete:
     '500':
       $ref: '../../../errors/errorResponses.yml#/components/responses/internalServerError'
 
+patch:
+  operationId: updateForm
+  summary: フォームの値を更新する
+  parameters:
+    - $ref: '../../../types/forms/parameters.yml#/parameters/id'
+    - $ref: '../../../types/forms/parameters.yml#/parameters/form_title'
+    - $ref: '../../../types/forms/parameters.yml#/parameters/form_description'
+    - $ref: '../../../types/forms/parameters.yml#/parameters/start_at'
+    - $ref: '../../../types/forms/parameters.yml#/parameters/end_at'
+  responses:
+    '200':
+      description: 指定されたFormの更新に成功
+      content:
+        application/json:
+          schema:
+            $ref: '../../../types/forms/definitions.yml#/definitions/form'
+    '400':
+      $ref: '../../../errors/errorResponses.yml#/components/responses/syntaxError'
+    '401':
+      $ref: '../../../errors/errorResponses.yml#/components/responses/unauthorized'
+    '404':
+      $ref: '../../../errors/errorResponses.yml#/components/responses/notFound'
+    '500':
+      $ref: '../../../errors/errorResponses.yml#/components/responses/internalServerError'
diff --git a/schema/types/forms/components.yml b/schema/types/forms/components.yml
@@ -15,19 +15,23 @@ components:
       type: string
       nullable: true
       example: このフォームはお問い合わせをする際にご回答いただくフォームです。
+    start_at:
+      description: 回答の受付を開始する日時
+      type: string
+      format: date-time
+    end_at:
+      description: 回答の受付を終了する日時
+      type: string
+      format: date-time
     response_period:
       description: 回答可能期間
       type: object
       nullable: true
       properties:
         start_at:
-          description: 回答の受付を開始する日時
-          type: string
-          format: date-time
+          $ref: '#/components/schemas/start_at'
         end_at:
-          description: 回答の受付を終了する日時
-          type: string
-          format: date-time
+          $ref: '#/components/schemas/end_at'
     settings:
       description: フォームの設定
       type: object

diff --git a/schema/types/forms/parameters.yml b/schema/types/forms/parameters.yml
@@ -6,11 +6,46 @@ parameters:
     required: true
     schema:
       $ref: './components.yml#/components/schemas/id'
+  form_title:
+    name: formTitle
+    in: query
+    description: フォームのタイトル
+    required: false
+    schema: 
+      $ref: './components.yml#/components/schemas/title'
+  form_description:
+    name: formDescription
+    in: query
+    description: フォームの説明
+    required: false
+    schema: 
+      $ref: './components.yml#/components/schemas/description'
+  start_at:
+    name: startAt
+    in: query
+    description: |
+      フォームの回答期間の開始日。
+      この開始日は回答可能期間に含まれます。
+      終了日(`end_at`)が指定されていない場合は失敗する可能性があります。
+      新たに設定する場合は`start_at`と`end_at`の両方を含めたパラメータを指定してください。
+    required: false
+    schema: 
+      $ref: './components.yml#/components/schemas/start_at'
+  end_at:
+    name: endAt
+    in: query
+    description: |
+      フォームの回答期間の終了日。
+      この終了日は回答可能期間に含まれます。
+      開始日(`start_at`)が指定されていない場合は失敗する可能性があります。
+      新たに設定する場合は`start_at`と`end_at`の両方を含めたパラメータを指定してください。
+    required: false
+    schema: 
+      $ref: './components.yml#/components/schemas/end_at'
   form_label_target:
     name: target
     in: query
     required: true
-    description: |
-      何に対してのラベルを取得するかを取得するか。
+    description: 何に対してのラベルを取得するかを取得するか。
     schema:
       $ref: './components.yml#/components/schemas/kind_of_labels'