View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0009594 | Taler | documentation | public | 2025-03-05 11:08 | 2025-03-05 11:08 |
| Reporter | reynir | Assigned To | Stefan | ||
| Priority | normal | Severity | minor | Reproducibility | N/A |
| Status | assigned | Resolution | open | ||
| 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. | ||||
