sheepla / sheepla/AxisEndpoints
Review the error response types specifications
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
I want to review the error response types specifications and improve the type-safe, OpenAPI-first design.
The current implementation required the use of IResult i.e. the "loose" type to return a custom error. However, this requires manual annotation to the Configure() method, which is different from the desired result that the type is safe and the OpenAPI schema is automatically derived by default.
Therefore, I will improve the IEndpoint interface so that the OpenAPI schema is automatically derived by explicitly specifying the type even if I return a custom error in my plan.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the IEndpoint interface and the Configure() method, focusing on how IResult is currently used for custom errors and how OpenAPI schemas are derived. Done means the design specifies custom error types explicitly while remaining type-safe and deriving the OpenAPI schema automatically by default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100