Closed equal-l2 closed 3 years ago
@equal-l2
追記:そもそもクエリにはヴァリデーションがない(本当は会ったほうが良いけど)
の記載も 隠れた前提
になりかねないので、お願いします。
@Stroheim001
いつからは設定せず、いつまでを設定した場合は、90日前から~指定した日付が取得される
これはOpenAPIのドキュメントのパラメータのデフォルト値に記載されています。 エンドポイント自体のdescriptionなどに書いた方がわかりやすければそうします。
クエリにはヴァリデーションがない
一応、YYYY-MM-DD
形式の正常な日付以外では400
とメッセージが返ってくるようにはなっています。
ただ、OpenAPIの方に記載がないことに気づいたので、その点は修正します。
他にvalidateすべきことがあれば言ってください。
@equal-l2 400でbad requrestになりますが、具体的にこれがアカン的な記載まで(エラーメッセージに)はありますか? (nuxtを経由するので、あり得ない話ではあるのですが念のため...)
@Stroheim001
現状だと、例えばuntil
がおかしい場合は以下のようなものが返ってきます。
{
"message": "'until' is malformed"
}
つまり、どのパラメータがおかしいかは記載がありますが、具体的にどうおかしいかは記載がないです。 (「どうおかしいか」をやりだすと最終的に手動でパースすることになるので……)
@equal-l2 わかりました。こちらとしては、万が一、変なクエリを投げてエラったら、その箇所がおかしいという告知だけするようにしておきます。 恐らくそれ以上は投げたクエリの検証を再度やりだしてケースが無限大に増えてしまうので...
@equal-l2 ドキュメントうるさいおじさんなので、大変もうしわけないのですが、エラッたときのexampleもOpenAPIに記載しておくと、たぶんnuxt作る人が楽というかなんでstkはこんな設計にしたの、の意図が分かると思います。 絶対とはいいませんが...
@Stroheim001 了解しました。すぐやります。
@equal-l2 ams-backend-nodejs.yml よくよく考えたらこの名前修正してないとなんか気持ち悪いねw
@Stroheim001 ドキュメントの追記と一緒にやっておきました。
@equal-l2 お手数おかけしましたorz
closes #75.