View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0009594 | Taler | documentation | public | 2025-03-05 10:08 | 2025-05-10 02:10 |
| Reporter | reynir | 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 | low | Severity | text | Reproducibility | N/A |
| Status | closed | Resolution | fixed | ||
| Product Version | git (master) | ||||
| Target Version | 1.0 | Fixed in Version | 1.0 | ||
| Summary | 0009594: No declared conventions for specifying JSON objects | ||||
| Description | Fairly early on in the documentation (1.2.1 under Conventions for Taler RESTful APIs) there is a specification of the shape of a ErrorDetail JSON object: https://docs.taler.net/core/api-common.html#tsref-type-ErrorDetail If you use an existing schema language it would be great to mention that somewhere early (for example in 1.2). Otherwise, a brief introduction would be nice. While I think it is mostly intuitive I can think of some easy misinterpretations. For example, the member »hint?: string;« has a question mark at the end. My guess is this means the member may be absent from the object. However, another possible interpretation is the value is null if not present. Finally, { "hint?": "this is fine" } is a perfectly valid JSON object. | ||||
| Tags | No tags attached. | ||||
| Hi Devan, I can imagine that this ticket is something for your plate as you know much more than me about the JSON terminology and conventions. And this is a post-1.0 ticket, so no hurry. THX for looking into it. | |
| After some searching it looks a lot like TypeScript. | |
| It's indeed all TypeScript based. We should probably find a nice place to say that. | |
| I'm not particularly familiar with this so I'll let someone else who is pick this one up. | |
| Fixed in e9fce14f..2fd3f15b, added sentence about using TypeScript in section 1.1. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2025-03-05 10:08 | reynir | New Issue | |
| 2025-03-05 10:08 | reynir | Status | new => assigned |
| 2025-03-05 10:08 | reynir | Assigned To | => Stefan |
| 2025-03-06 11:30 | Stefan | Note Added: 0024167 | |
| 2025-03-06 11:30 | Stefan | Assigned To | Stefan => dvn |
| 2025-03-06 14:49 | reynir | Note Added: 0024170 | |
| 2025-03-07 01:58 | Christian Grothoff | Priority | normal => low |
| 2025-03-07 01:58 | Christian Grothoff | Severity | minor => text |
| 2025-03-07 01:58 | Christian Grothoff | Target Version | => post-1.0 |
| 2025-03-07 01:58 | Christian Grothoff | Note Added: 0024173 | |
| 2025-03-10 13:01 | dvn | Assigned To | dvn => |
| 2025-03-10 13:03 | dvn | Note Added: 0024174 | |
| 2025-04-17 22:14 | Christian Grothoff | Assigned To | => Christian Grothoff |
| 2025-04-18 12:59 | Christian Grothoff | Status | assigned => informing |
| 2025-04-18 12:59 | Christian Grothoff | Resolution | open => fixed |
| 2025-04-18 12:59 | Christian Grothoff | Fixed in Version | => 1.0 |
| 2025-04-18 12:59 | Christian Grothoff | Note Added: 0024605 | |
| 2025-05-08 13:32 | Christian Grothoff | Product Version | => git (master) |
| 2025-05-08 13:32 | Christian Grothoff | Target Version | post-1.0 => 1.0 |
| 2025-05-10 02:10 | Christian Grothoff | Status | informing => closed |