View Issue Details

IDProjectCategoryView StatusLast Update
0007669Talerdocumentationpublic2023-09-28 11:22
ReporterMS Assigned ToAntoine A Resolution deadline
ImplementerReviewer 
Release signed byDeployed by 
VerifierCommunicator 
Data protection authority notification requiredNo  
CSIRT notification requiredNo  
Estimated effort (hours)Actual effort (hours)0 
Fast-trackNo
Work packagenone
PrioritynormalSeveritytextReproducibilityhave not tried
Status closedResolutionfixed 
Target Version0.9.3Fixed in Version0.9.3 
Summary0007669: Document data types used in libeufin REST calls.
DescriptionOne example are amounts: there should be one document that specifies their format.
Along this, the API docs have to point at those specifications whenever the said type is
mentioned. The same way that Taler does with api-common.rst.
TagsNo tags attached.

Required notifications

Address or linkRemarkAdded byNotifiedActions

Activities

MS

2023-02-09 15:52

reporter   ~0019791

be6eb54..af11ed5 starts to address this. Notably, the size in bits of the integer part of amounts is not documented.

Christian Grothoff

2023-09-23 13:46

manager   ~0020527

Now done?

Christian Grothoff

2023-09-23 14:39

manager   ~0020532

Antoine: unless MS says this is done, maybe you can do a pass over the REST API (chapter 1.11) and see if there are any inputs/outputs that are still not properly documented.

MS

2023-09-25 09:41

reporter   ~0020536

That's done. It was already done along the obsoleted API, and even more now that all the APIs got refactored. If Nexus still has this type of issue, that shouldn't keep this open, as Nexus will very likely STOP offering any HTTP REST API.

Issue History

Date ModifiedUsernameFieldChange
2023-02-09 15:07MSNew Issue
2023-02-09 15:52MSNote Added: 0019791
2023-04-13 18:50Florian DoldProjectlibeufin => Taler
2023-04-17 09:49Florian DoldTarget Version => 0.9.4
2023-04-17 09:49Florian DoldSummaryDocument data types used in REST calls. => Document data types used in libeufin REST calls.
2023-05-04 18:11Christian GrothoffSeverityminor => text
2023-09-23 13:46Christian GrothoffNote Added: 0020527
2023-09-23 14:38Christian GrothoffAssigned To => Antoine A
2023-09-23 14:38Christian GrothoffStatusnew => assigned
2023-09-23 14:39Christian GrothoffNote Added: 0020532
2023-09-25 09:41MSNote Added: 0020536
2023-09-25 09:42MSStatusassigned => informing
2023-09-25 09:42MSResolutionopen => fixed
2023-09-28 11:21Christian GrothoffFixed in Version => 0.9.3
2023-09-28 11:21Christian GrothoffTarget Version0.9.4 => 0.9.3
2023-09-28 11:22Christian GrothoffStatusinforming => closed