View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0009388 | Taler | documentation | public | 2024-12-16 11:24 | 2026-03-20 23:55 |
| Reporter | oec | 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 | text | Reproducibility | have not tried |
| Status | closed | Resolution | fixed | ||
| Product Version | git (master) | ||||
| Target Version | 1.5 | Fixed in Version | 1.5 | ||
| Summary | 0009388: Add semver information to REST-API endpoints | ||||
| Description | Right now, docs.taler.net does not contain API version information per REST-API endpoint. Soon we will have a situation where some API's are only available in some version (ranges). We should add the open and closed ranges of the semver Version per API-Endpoint to the documentation of the REST-API documentation of (at least) exchange and merchant. Note that this also means that we _might_ need to add semver information to particular data structures, interfaces and their members. | ||||
| Tags | No tags attached. | ||||
| related to | 0009441 | closed | Christian Grothoff | Protocol version missing in public documentation |
| 5875b7ec..63b675a7 adds version documentation to each of the APIs. Note that we do NOT use semver, we use libtool-style versioning for protocols (with ranges). So to see the range, you need to look at "@since" and possibly "@deprecated" annotations to see which range of protocols a particular field or endpoint is supported for. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2024-12-16 11:24 | oec | New Issue | |
| 2024-12-16 11:24 | oec | Status | new => assigned |
| 2024-12-16 11:24 | oec | Assigned To | => Stefan |
| 2024-12-16 11:28 | oec | Description Updated | |
| 2024-12-16 11:28 | oec | Assigned To | Stefan => oec |
| 2024-12-16 14:32 | oec | Target Version | post-1.0 => 1.0 stretch goals |
| 2025-04-17 20:23 | Christian Grothoff | Target Version | 1.0 stretch goals => post-1.0 |
| 2025-05-08 20:45 | Christian Grothoff | Assigned To | oec => |
| 2025-05-08 20:45 | Christian Grothoff | Severity | feature => text |
| 2025-05-08 20:45 | Christian Grothoff | Status | assigned => implementing |
| 2026-02-07 21:45 | Christian Grothoff | Relationship added | related to 0009441 |
| 2026-02-07 21:45 | Christian Grothoff | Assigned To | => Christian Grothoff |
| 2026-02-07 21:45 | Christian Grothoff | Status | implementing => assigned |
| 2026-02-07 21:45 | Christian Grothoff | Status | assigned => implementing |
| 2026-02-27 21:24 | Christian Grothoff | Note Added: 0027933 | |
| 2026-02-27 21:24 | Christian Grothoff | Status | implementing => informing |
| 2026-02-27 21:24 | Christian Grothoff | Resolution | open => fixed |
| 2026-02-27 21:24 | Christian Grothoff | Fixed in Version | => 1.5 |
| 2026-02-27 21:24 | Christian Grothoff | Target Version | post-1.0 => 1.5 |
| 2026-03-20 23:55 | Christian Grothoff | Status | informing => closed |