[ARCHIVE] Multiple Simultaneous end point versions

Archived 21/02/2024. Please see Endpoint Version Schedule.

Update: In the Version 1.7.0 of the Consumer Data Standards a draft Endpoint Version Schedule has been included to assist in the management of existing and future Endpoints.

Question

Are Data Holders REQUIRED to support multiple simultaneous versions of the same end point?

With respect to end point versioning, specifically for Product Reference Data.

During the transition period covering the release of a new minor version of an end point (e.g. version 1 being replaced by version 2 of the GET Products APIs), is it expected that;

• DHs will be allowed to upgrade from V1 to V2 in one activity, both releasing V2 and deprecating support for V1 at the same time? The effect of this would be that support for simultaneous versions would reside with the 3rd party consuming systems, as they would need to support both old and new versions until all DHs have upgraded to the new version.

OR

• DHs are expected to provide support for both the old AND the new versions of an end point during the transition period? The effect of this would be that support for simultaneous versions would reside with the data holders and consuming systems would be able to upgrade at any time during the transition period.

Which of these (A or B) is the expected approach?

Assumptions for this question: the only reason multiple versions of the same endpoint would exist ‘live’ at the same time is to support the transition from the old to the new, and that there would never be more than TWO versions of any endpoint simultaneously live.

Are these valid assumptions?

Answer

There is nuance in the answer to your problem here.

In the case of an ADI commencing obligations - such as the non-majors being required to share product reference data (PRD) from July 2020, they can choose to go-live with version 2 support and do not have to support version 1 of the PRD endpoints. See here: #201

Where a Data Holder already has an API in market, the Data Holder should maintain that version up until the retirement date specified in the standards. Similarly, the Data Holder must support any newer versions by their support dates listed in the Future Dated Obligations. This aligns to Option B you present.

This means that a Data Holder should expect to have some endpoints in production where they are supporting more than one version. A Data Holder must follow the Versioning guidelines including data recipient version negotiation with x-v and x-min-v headers.

See

• Standards Maintenance Issue 201
• Standards Maintenance Issue 209
• Endpoint Version Schedule