search

kintone / js-sdk-ja

kintone/js-sdk の日本語でのバグ報告、機能提案用リポジトリ
https://github.com/kintone/js-sdk
4 stars 0 forks source link

[Bug] KintoneRestAPIErrorのドキュメントに「errors」オブジェクトが載っていない #42

Open the-red opened 11 months ago

the-red commented 11 months ago

概要

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/errorHandling.md#kintonerestapierror 公式ドキュメントでは、KintoneRestAPIErrorのプロパティ内でエラーの手がかりになりそうなのは messageくらいしかありません。 しかし実際にはerrorsというオブジェクトがあって、 この中にはエラーの詳細がかなり詳しく入っています。

エラーハンドリングの際にはいつもこのKintoneRestAPIError#errorsを使うのですが、 なぜドキュメントにはerrorsオブジェクトが明記されてないのでしょうか？ これがないとまともなエラーハンドリングができないので、ぜひドキュメントで言及してください。 ドキュメントに書いてある情報だけでエラーハンドリングしようとすると、 APIを生で叩くほうがマシになってしまいます。 よろしくお願いします。

対象パッケージ

@kintone/rest-api-client

対象バージョン

5.0

再現手順

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/errorHandling.md#kintonerestapierror このドキュメントを読む

期待する挙動

ドキュメント内にKintoneRestAPIError#errorsについての詳細が載っている状態

実際の挙動

ドキュメント内にKintoneRestAPIErrorについて触れられていない

環境

環境問わず

tasshi-me commented 11 months ago

@the-red 確認が遅くなりすみません、フィードバックありがとうございます！

こちらチーム内で検討させていただきます！ ※errorsプロパティ自体の追加は行う方針で進めると思います。