Skip to content

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

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.

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

Open
the-red opened this issue Dec 10, 2023 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@the-red
Copy link

the-red commented Dec 10, 2023

概要

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について触れられていない

環境

環境問わず

@the-red the-red added the bug Something isn't working label Dec 10, 2023
@the-red the-red changed the title [Bug] KintoneRestAPIErrorのドキュメントにも「errors」オブジェクトが載っていない [Bug] KintoneRestAPIErrorのドキュメントに「errors」オブジェクトが載っていない Dec 10, 2023
@tasshi-me tasshi-me added documentation Improvements or additions to documentation bug Something isn't working and removed bug Something isn't working labels Dec 23, 2023
@tasshi-me
Copy link
Member

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants