Release Notes - Major release Profile 2019-1

Profile release date: 2019-07-01

Major changes
JIRA-referenceSpecification typeSpecification nameComments-
BOBX-9 - Getting issue details... STATUS *APIParticipant Metadata
  • Changes to support individual version handling of endpoints
  • Implementation of changes to Participant metadata Service
-
BOBX-6 - Getting issue details... STATUS APITicket
  • Revised solution for "Hindered status" in GET & PUT methods.
-
BOBX-7 - Getting issue details... STATUS APIProduct
  • Spelling correction for parameter "temporal"
-
BOBX-12 - Getting issue details... STATUS APIProduct
  • Incompatible bug changes to spatialValidity
-
BOBX-14 - Getting issue details... STATUS APIValidation
  • X-BoB-AuthToken *required added in Ticklemacros methods.
-
BOBX-5 - Getting issue details... STATUS APIDevice
  • X-BoB-AuthToken parameter set as required
-
Minor and/or Patch changes within Major Profile
JIRA-referenceSpecification typeSpecification nameVersionVersioning TypeCommentsDate

BOBX-9 - Getting issue details... STATUS *

MTSAll MTS's
Patch
  • Revision of section 1.1 Versioning policy. 
2019-07-01
BOBX-9 - Getting issue details... STATUS *SchemaAll Schemas
Patch
  • Version attribute added to BoB Shema files to adapt to Semantic and individual versioning. 
2019-07-01
BOBX-9 - Getting issue details... STATUS *APIAll API's
Patch
  • The version attribute in .yaml-files have values according to Semantic versioning syntax (major.minor.patch).

NOTE 1: this change is a patch in itself and the corresponding version for API's is 1.3.2 except for the above listed Major-affected API's which got version 2.0.0 

2019-07-01

BOBX-9 - Getting issue details... STATUS *

--
-
  • This change demanded creation of individual repositories for each specification (API, MTS, Schema) in Bitbucket to support individual version handling - which means individual handling of repository cloning. 

2019-07-01

BOBX-24 - Getting issue details... STATUS MTSMTS71.1.0Minor
  • Clearer description on how the conversion between integer and bytes is supposed to be done when the "AID" is configured
2020-01-16
BOBX-32 - Getting issue details... STATUS

MTS

Schema

MTS3

bob-schema-coordinated-namespace

1.1.0

1.5.0

Minor
  • New parameter "sov" (start of validity) is to be added in MTS3 and schema coordinated-name-space

2020-01-15

APIValidation2.0.1Patch
  • Removed unused travellersPerCategory
  • Added object definitions to match with Ticket API
  • Added descriptions and examples
2020-03-02

APIInspection1.3.3Patch
  • Added descriptions and examples
2020-03-02

APITicket2.0.1Patch
  • Added object tokenTransaction in ticketEventResult
  • Added object aiData
  • Added OperationId setTicketRevokeStatus
2020-03-02

APIToken1.3.3Patch
  • Changed format from {type: number, format: int64} to {type: integer, format: int64} for (serial/pid)
2020-04-09

APITicket2.0.2Patch
  • Added tokenId to manifestCall & ticketBundleRequest, in case tokenId is different from tokenPublicKey thumbprint
2020-04-09

Schemabob-schema-coordinated-namespace1.5.1Patch
  • Corrected spelling error
2020-04-09

APITicket2.0.3Patch
  • Undated text regarding the use of unique requestId and localEventId in POST-methods if retransmission functionality is wanted.
  • Updated method with new code 303 Ticket already exists
2020-04-30

APIValidation2.0.2Patch
  • Undated text regarding the use of unique requestId and localEventId in POST-methods if retransmission functionality is wanted.
  • Updated method with new code 303 Ticket event already exists
2020-04-30

APIInspection1.3.4Patch
  • Undated text regarding the use of unique requestId and localEventId in POST-methods if retransmission functionality is wanted.
  • Updated method with new code 303 Ticket event already exists
2020-04-30
BOBX-30 - Getting issue details... STATUS APIProduct2.1.0Minor
  • Updated description of fares in a product
  • Updated descriptions regarding surcharges in productProperties in a product
  • Added parameter "label" in fare, surcharge and surcharges
2020-08-12
BOBX-25 - Getting issue details... STATUS APIToken1.4.0Minor
  • Changed parameter "kid" to not required
2020-12-09
BOBX-41 - Getting issue details... STATUS APITicket2.0.4Patch
  • Changed freeze and thaw to deactivate and activate in descriptions

  • Updated descriptions to fit changes

2020-12-09
BOBX-42 - Getting issue details... STATUS APIValidation2.0.3Patch
  • Updated descriptions for GET /ticklemacro and GET /ticklemacro/{serial}
  • Updated response code description
2020-12-09
BOBX-43 - Getting issue details... STATUS

API

Schema

Product

bob-schema-generic-categories

2.2.0

1.0.0

Minor
  • Added a genericCategory beside the current categories fareCategory, travellerCategory and productCategory

  • Added two schemas that defines rekommended values to use

2020-12-09
BOBX-44 - Getting issue details... STATUS APIProduct2.2.0Minor
  • Added age and proof of conditions to GET /productCat/traveller.

2020-12-09
BOBX-45 - Getting issue details... STATUS

API

Product


2.2.0

Minor
  • Extend product property declaration with a "values" parameter and a "group" parameter.
  • values - Optional. Possible values of the product property.

  • group - Optional. Introduces the possibility to group properties together making it possible for a sales client to group them together in a GU

2020-12-09
BOBX-46 - Getting issue details... STATUS APIProduct2.2.0Minor
  • Added the parameter "discountCode" to POST /product request and response
2020-12-09
BOBX-57 - Getting issue details... STATUS APIValidation

2.0.4

Patch
  • Clarify how to remove a blacklist entry
2021-08-25
BOBX-58 - Getting issue details... STATUS APIProduct

2.2.1

Patch
  • Improved documentation and added examples
2021-10-14
BOBX-59 - Getting issue details... STATUS APITicket

2.0.6

Patch
  • Improved documentation and added examples
2021-10-14
BOBX-60 - Getting issue details... STATUS API

Validation

Inspection

2.0.5

1.3.5

Patch
  • Improved documentation and added examples
2021-10-14
BOBX-61 - Getting issue details... STATUS APIAuthentication1.3.3Patch
  • Improved documentation and added examples
2021-11-24
BOBX-53 - Getting issue details... STATUS

API






Schema

Traveller

Product

Ticket

Validation

Inspection

Token

bob-schema-product-conditions

3.0.0

2.3.0

2.1.0

2.1.0

1.4.0

1.5.0

1.0.0

Minor
  • Traveller API updated to version 3. It provides functionality for other participants to perform operations on a traveller's account.
    The previous version was not used by anyone.
  • Added support for product conditions
2021-12-13
BOBX-54 - Getting issue details... STATUS APIValidation2.2.0Minor
  • Add ticketId to whitelist response
2022-05-31
BOBX-63 - Getting issue details... STATUS APIValidation2.2.0Minor
  • Add limit and skip to blacklist and whitelist
2022-05-31
BOBX-62 - Getting issue details... STATUS
Ticket2.2.0Minor
  • Add GET /ticket/{ticketId}/revoke endpoint to Ticket API

2022-05-31
BOBX-64 - Getting issue details... STATUS
Product2.4.0Minor
  • Deprecate validityPeriod and extendedValidityPeriod in POST /product

2022-05-31

BOBX-55 - Getting issue details... STATUS

BOBX-65 - Getting issue details... STATUS

BOBX-66 - Getting issue details... STATUS


Participant metadata2.1.0Minor
2022-05-31
BOBX-67 - Getting issue details... STATUS APITicket2.3.0Minor
  • Add support for transporting the identifier of the device to which a ticket should be bound
  • Add support for transporting pid of the device signature issuer
  • Add support for requesting a shorter (or longer) issuer signature lifetime

2023-05-03


BOBX-68 - Getting issue details... STATUS APIValidation2.3.0Minor
  • Add an inception property for blacklist entries.
2023-05-03
BOBX-69 - Getting issue details... STATUS API

Ticket

Validation

Inspection

2.3.0

2.3.0

1.5.0

Minor
  • Add an inspector property to the Inspection API ticketEvent object.
2023-05-03
BOBX-70 - Getting issue details... STATUS APIParticipant Metadata2.2.0Minor
  • Add a DELETE method for ParticipantInfo to Participant Metadata API.
2023-05-03
BOBX-72 - Getting issue details... STATUS APITicket2.3.0Minor
  • Add endpoint PATCH /ticketbundle/{ticketBundleId} to Ticket API.
2023-05-03
BOBX-73 - Getting issue details... STATUS

API




MTS

Device

Validation

Inspection

Ticket

MTS 1

2.1.0

2.3.0

1.5.0

2.3.0

1.7.0

Minor
  • Add ua field in the Device Signature Protected Header in MTS1
  • Add endpoints GET /device/userAgent and GET /device/userAgent/{ua} to Device API.
  • Add ua property in the deviceReference definition, which is part of the ticketEvent definition, in the Validation API, the Inspection API and the Ticket API.
2023-05-03
BOBX-74 - Getting issue details... STATUS APITicket2.3.0Minor
  • Add an inspector property to the Inspection API ticketEvent object.
2023-05-03
BOBX-48 - Getting issue details... STATUS APIProduct2.5.0Minor
  • Change product property parameter "value" to not required in POST /product

2023-11-24
BOBX-75 - Getting issue details... STATUS APIProduct2.5.0Minor
  • Add new operation GET /pds in Product API

2023-11-24
BOBX-76 - Getting issue details... STATUS API

Device

Product

Ticket

Validation

Inspection

Traveller

Booking

Participant metadata

1.3.2

2.5.0

2.3.1

2.3.1

1.5.1

1.3.3

1.3.3

1.3.2

Minor
  • Remove 'host:' in BoB-API:s

2023-11-28
BOBX-84 - Getting issue details... STATUS APIParticipant metadata1.4.0Minor
  • Restrict signing scope for MTB keys

2024-10-29


Footnotes

* Related and implemented towards internal Samtrafiken JIRA-child issue.