View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0006432 | Taler | merchant backend | public | 2020-07-16 18:15 | 2024-01-12 13:04 |
| Reporter | Florian Dold | Assigned To | Christian Grothoff | Resolution deadline | |
| Implementer | Reviewer | ||||
| Release signed by | Deployed by | ||||
| Verifier | Communicator | ||||
| Data protection authority notification required | No | ||||
| CSIRT notification required | No | ||||
| Estimated effort (hours) | Actual effort (hours) | 0 | |||
| Fast-track | No | ||||
| Work package | none | ||||
| Priority | normal | Severity | tweak | Reproducibility | have not tried |
| Status | closed | Resolution | fixed | ||
| Product Version | git (master) | ||||
| Target Version | 0.8 | Fixed in Version | 0.8 | ||
| Summary | 0006432: consider making API error responses more developer friendly | ||||
| Description | Some endpoints of the merchant now seem to *only* return the numeric "code", which makes it really tedious for developers who want to integrate with the merchant (or even configure it!). For example, if I mistype some endpoint name I get { "code": 10 } which is really unhelpful. We already generate a header with the error codes, we should consider adding the alphanumeric name for the error as "non-normative" extra information. By now (younger than Taler ;-) ), there is also an RFC that defines the format for the "application/problem+json" MIME type: https://tools.ietf.org/html/rfc7807. Using this might be a bit too much, as all errors are required to have a canonical URL for the error type, such as "https://taler.net/errors#DEPOSIT_DENOMINATION_KEY_UNKNOWN". However, just adding the alphanumeric name for the error code to the error JSON would already go a long way! | ||||
| Tags | No tags attached. | ||||
| Changed the API to create the 'hint' from the error code, and to use an optional string for "detail" where additional relevant information may be passed. Merchant change in Git 0acefc9..d354d11. | |
| We now consistently return the 'hint' as a human-readable string of the 'code', and additionally provide 'detail' about the failure in more cases. | |
| Fix committed to master branch. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2020-07-16 18:15 | Florian Dold | New Issue | |
| 2020-07-16 18:15 | Florian Dold | Status | new => assigned |
| 2020-07-16 18:15 | Florian Dold | Assigned To | => Christian Grothoff |
| 2020-07-16 19:10 | Christian Grothoff | Severity | minor => tweak |
| 2020-07-16 19:10 | Christian Grothoff | Product Version | => git (master) |
| 2020-08-19 17:36 | Christian Grothoff | Target Version | => 0.8.1 |
| 2020-08-25 18:39 | Christian Grothoff | Note Added: 0016769 | |
| 2020-08-25 19:02 | Christian Grothoff | Status | assigned => informing |
| 2020-08-25 19:02 | Christian Grothoff | Resolution | open => fixed |
| 2020-08-25 19:02 | Christian Grothoff | Fixed in Version | => 0.8 |
| 2020-08-25 19:02 | Christian Grothoff | Note Added: 0016772 | |
| 2020-08-25 19:02 | Christian Grothoff | Target Version | 0.8.1 => 0.8 |
| 2021-08-24 14:23 | Christian Grothoff | Status | informing => closed |
| 2021-09-02 16:22 | Christian Grothoff | ||
| 2021-09-02 16:23 | Christian Grothoff | Note Added: 0018371 | |
| 2024-01-12 13:04 | Christian Grothoff | Category | merchant backend API (C) => mechant backend |
| 2025-03-22 13:09 | Christian Grothoff | Category | mechant backend => merchant backend |