[DOCS]: Error response schema

[markcellus]

Describe the need

I realize the package is just likely returning what comes from the official REST API, but can the schema for a response error be documented? I'm trying to ensure my code knows how to handle the different error responses.

I'm able to deduce that each error response has a status property, but that's all that the Github REST API seems to indicate. I'm sure there are other properties besides status because I'm seeing other things like code, message, headers, etc. Are these documented somewhere? If so, can the README be updated to point to it? If not, it would be great if it can be added.

Thanks in advance.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[wolfy1339]

Errors from requests are implemented in @octokit/request-error
The documentation you want is probably there already

[markcellus]

Thanks this is helpful. Unfortunately its not clear that one would need to navigate to another package to learn about errors raised in this package, without digging into the codebase.

Is it possible to just add a sentence on the README that links to that? I'd be willing to open a PR for this if that would help.

[wolfy1339]

Of course, PRs are welcome!