juspay/hyperswitch

[ENHANCEMENT]:Add scoped error enums for disputes API

Open

#1,564 opened on Jun 28, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Rust (42,690 stars) (4,676 forks)batch import
A-disputesA-errorsC-refactorE-mediumgood first issuehelp wanted

Description

We have a set of API endpoints related to handling disputes from the merchant Currently the API's used with this return RouterResponse or ApiErrorResponse

We wanna deprecate ApiErrorResponse and instead use scoped API errors for each API...

Currently this are the errors faced by dispute API...

StorageErrors (we return InternalApiError here)
PaymentNotFound
DisputeStatusValidationFailed
ExternalConnectorError
UpdateFailure (same as storage error or internalservererror)
DisputeFileNotFound
DisputeFileNotAvailable
MissingDisputeId
MissingFilePurpose
MissingFileContentType

These errors returned here should have their own enum via error stack to give better context in terms of scoped errors...

Then these errors could be again. mapped to an appropriate Api Error via the ErrorSwitch trait we already use

Contributor guide

Tech stack
rustrest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust error handlingHyperswitch codebase structureDisputes API endpoints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Look at the existing error enums in the codebase to understand the pattern (e.g., in `crates/router/src/errors/`). Check the comments on this issue for any additional guidance. Then, create a new scoped error enum for the disputes API following the same pattern, and implement the `ErrorSwitch` trait to map these errors to the appropriate `ApiError` variants.