From 5dad5e9650ec15347b043de47f2a54daf94cc7b5 Mon Sep 17 00:00:00 2001 From: rito528 <39003544+rito528@users.noreply.github.com> Date: Tue, 31 Oct 2023 21:53:25 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20form=E3=81=AB=E5=85=AC=E9=96=8B?= =?UTF-8?q?=E8=A8=AD=E5=AE=9A=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- schema/paths/forms/[formId]/index.yml | 1 + schema/types/forms/components.yml | 14 ++++++++++++++ schema/types/forms/parameters.yml | 7 +++++++ 3 files changed, 22 insertions(+) diff --git a/schema/paths/forms/[formId]/index.yml b/schema/paths/forms/[formId]/index.yml index ad9f823..31d01ac 100644 --- 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 index 38d7816..c5a9d42 100644 --- 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 index 553d368..31b5fff 100644 --- 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