Inconsistent parameters for manifest in POST/manifest and POST/ticket
Description
Attachments
3
Activity
Show:
Former user December 9, 2020 at 4:03 PM
Merged to the BoB-standard 2020-12-09 and created a new major release profile 2020-1
Close
Former user November 13, 2020 at 10:12 AM
Approved at CAB 2020-11-10
Former user October 1, 2020 at 9:05 AM
Former user September 30, 2020 at 8:09 AM
Sent out for referral
Fixed
Details
Details
Assignee
Unassigned
UnassignedReporter
Former userVersioning
Major
Priority
When time is availableWho's Looking?
Open Who's Looking?
Created February 28, 2020 at 11:00 AM
Updated December 9, 2020 at 4:03 PM
Resolved November 12, 2020 at 6:27 AM
Who's Looking?
Background
During the work within the VSB-project and implementation of Openbob, Samtrafiken is analyzing the BoB-specifications to both understand what to implement but also for the management of the standard to seek consistency, improvements and clarity.
Problem
Inconsistent parameter naming - In method POST/manifest in Product API there is a parameter called "manifest" and in POST/ticket in Ticket API corresponding parameter is called "manifestMtbTemplate" - both however with the same description: “Signed manifest with MTB template”.
Need
Consistency - so that different interpretations are avoided.
Clarity - so that unnecessary time waste analyzing specifications are avoided.
Motivation
Since there is nothing in the standard that says that the manifest should/must be a template for the MTB, it is up to each implemetator, then “manifest” is probably a better choice than “manifestMtbTemplate”. From the standard: “The manifest contains the information required by the Ticketing Service to issue the ticket and to produce the data necessary for financial set-off and statistics”.
Suggestion
Rename parameter so that it is referring to “manifest” in both places.
and change the description to “Signed manifest”.