docs: formに公開設定を追加

GiganticMinecraft · Oct 31, 2023 · 5dad5e9 · 5dad5e9
1 parent ed83741
commit 5dad5e9
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/schema/paths/forms/[formId]/index.yml b/schema/paths/forms/[formId]/index.yml
@@ -53,6 +53,7 @@ patch:
     - $ref: "../../../types/forms/parameters.yml#/parameters/end_at"
     - $ref: "../../../types/forms/parameters.yml#/parameters/webhook_url"
     - $ref: "../../../types/forms/parameters.yml#/parameters/default_title"
+    - $ref: "../../../types/forms/parameters.yml#/parameters/visibility"
   responses:
     "200":
       description: 指定されたFormの更新に成功

diff --git a/schema/types/forms/components.yml b/schema/types/forms/components.yml
@@ -41,6 +41,18 @@ components:
         これが設定されていないとタイトルは「未設定」となります。
       type: string
       example: 未設定
+    visibility:
+      description: |
+        フォームの公開設定。
+
+        | ENUM     | 説明         | 
+        | -------- | ------------| 
+        | PUBLIC     | 全体公開 | 
+        | PRIVATE | 非公開 |
+      type: string
+      enum:
+        - PUBLIC
+        - PRIVATE
     settings:
       description: フォームの設定
       type: object
@@ -51,6 +63,8 @@ components:
           $ref: "#/components/schemas/webhook_url"
         default_title:
           $ref: "#/components/schemas/default_title"
+        visibility:
+          $ref: "#/components/schemas/visibility"
     created_at:
       description: フォームの作成日時
       type: string

diff --git a/schema/types/forms/parameters.yml b/schema/types/forms/parameters.yml
@@ -59,6 +59,13 @@ parameters:
     required: false
     schema:
       $ref: "./components.yml#/components/schemas/default_title"
+  visibility:
+    name: visibility
+    in: query
+    description: フォームの公開設定
+    required: false
+    schema:
+      $ref: "./components.yml#/components/schemas/visibility"
   form_label_target:
     name: target
     in: query