Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: visibility が public なフォーム、private なフォームを分けて取得するエンドポイントを定義 #162

Merged
merged 1 commit into from
Aug 27, 2024
Merged

feat: visibility が public なフォーム、private なフォームを分けて取得するエンドポイントを定義 #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions src/endpoints/forms.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ namespace Forms {
};

/**
* フォームの一覧を返す。
*
* このエンドポイントでは最小限のフォーム情報を含むリストが返されます。
*
* また、取得パラメータとしてlimitとoffsetを指定し、取得件数を絞り込むことができます。
Expand All @@ -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
Expand Down