microsoft / microsoft/kiota-ruby
generation - Expose Response Headers in API exception/error [Ruby]
Open
Nobody has claimed this yet.
enhancement
help wanted
ruby
- Dominant language
- Ruby
- Stars
- 5
- Forks
- 8
- Avg merge
- 11h 9m
- Merged PRs (30d)
- 24
Description
To improve the error handling experience we need to add the response headers the main api error type:
- add a response headers field to the Api exception class
- add corresponding accessors (if needed)
- populate the information in the request adapter when an error is encountered
Examples
Dotnet
- https://github.com/microsoft/kiota-abstractions-dotnet/pull/79
- https://github.com/microsoft/kiota-http-dotnet/pull/94
Java
Typescript
Go
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Ruby Api exception class and the request adapter mentioned in the issue, then compare the linked .NET, Java, TypeScript, and Go implementations. Done means response headers are exposed on the exception and populated by the adapter when an error is encountered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100