From 1ce8670423ec7bfa74c73573637e55522165bd23 Mon Sep 17 00:00:00 2001 From: rito528 <39003544+rito528@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:19:12 +0900 Subject: [PATCH] =?UTF-8?q?feat:=20visibility=20=E3=81=8C=20public=20?= =?UTF-8?q?=E3=81=AA=E3=83=95=E3=82=A9=E3=83=BC=E3=83=A0=E3=80=81private?= =?UTF-8?q?=20=E3=81=AA=E3=83=95=E3=82=A9=E3=83=BC=E3=83=A0=E3=82=92?= =?UTF-8?q?=E5=88=86=E3=81=91=E3=81=A6=E5=8F=96=E5=BE=97=E3=81=99=E3=82=8B?= =?UTF-8?q?=E3=82=A8=E3=83=B3=E3=83=89=E3=83=9D=E3=82=A4=E3=83=B3=E3=83=88?= =?UTF-8?q?=E3=82=92=E5=AE=9A=E7=BE=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/endpoints/forms.tsp | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/src/endpoints/forms.tsp b/src/endpoints/forms.tsp index 3295450..0070c00 100644 --- a/src/endpoints/forms.tsp +++ b/src/endpoints/forms.tsp @@ -40,8 +40,6 @@ namespace Forms { }; /** - * フォームの一覧を返す。 - * * このエンドポイントでは最小限のフォーム情報を含むリストが返されます。 * * また、取得パラメータとしてlimitとoffsetを指定し、取得件数を絞り込むことができます。 @@ -56,6 +54,34 @@ namespace Forms { @query offset?: uint32, + @doc("取得件数の上限値 例えば、limitを10とすると10番目までのデータが取得できます。") + @minValue(1) + @query + limit?: uint32, + ): { + @statusCode statusCode: 200; + @body body: MinimalForm[]; + } | { + @statusCode statusCode: 400 | 401 | 403 | 500; + @body body: Error; + }; + + /** + * このエンドポイントでは最小限のフォーム情報を含むリストが返されます。 + * このエンドポイントからは `visibility` が `PUBLIC` であるフォームのみが取得されます。 + * + * また、取得パラメータとしてlimitとoffsetを指定し、取得件数を絞り込むことができます。 + * レスポンス内容はid基準とし、昇順ソートしたものになります。 + */ + @route("/public") + @get + @summary("PUBLICなフォームの一覧取得") + op privateList( + @doc("取得件数の下限値 例えば、offsetを1とすると2件目からのデータが取得できます。") + @minValue(0) + @query + offset?: uint32, + @doc("取得件数の上限値 例えば、limitを10とすると10番目までのデータが取得できます。") @minValue(1) @query