Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation and retirement dates for CDR Register superseded endpoint versions needs to be defined #452

Closed
CDR-API-Stream opened this issue Jan 4, 2022 · 2 comments
Labels

Comments

@CDR-API-Stream
Copy link
Collaborator

Description

With the introduction of #424 and #425, the CDR Register will release new versions of the API endpoints using endpoint versioning. Multiple versions of the endpoints will be valid for a period of time and as part of this work, old endpoint versions have not had deprecation or retirement dates defined.

This issue is being raised to determine what an appropriate deprecation and retirement schedule should look like.

Area Affected

CDR Register APIs and their associated Endpoint Version Schedule.

Change Proposed

The result of this work will be a defined deprecation and retirement date for superseded CDR Register endpoint versions

@CDR-API-Stream
Copy link
Collaborator Author

CDR-API-Stream commented Mar 30, 2022

The DSB proposes the deprecation and retirement dates for the old CDR Register endpoint versions, superseded by the work in #424 and #425, should follow the conventions already established by the DSB.

Currently, the alignment of the new endpoints is being assessed through #465
Assuming these endpoint obligation dates are set to the Energy release time frame of 15/11/2022, the following dates would apply:

  1. Deprecation dates are defined by the introduction of new endpoint definitions in V1.15.0 of the standards: 23/12/2021
  2. Old endpoint versions superseded by the introduction of new CDR Register endpoint versions: 15/11/2022
  3. Retirement dates for superseded CDR Register endpoints: 07/04/2023

Retirement dates for these endpoints represent 3 months beyond the deprecation dates, plus a buffer to accommodate end-of-year industry shutdowns.

@CDR-API-Stream
Copy link
Collaborator Author

Deprecation and retirement dates are reflected as follows:

API Endpoint Version Binding Date Retirement Date Date Introduced Date Deprecated
Get Data Holder Brands /{industry}/data-holders/brands V1 2021-10-29 2023-04-07 2021-10-29, V1.14.0 2021-2-23, V1.15.0
Get Software Statement Assertion (SSA) /{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa V2 2021-10-29 2023-04-07 2021-10-29, V1.14.0 2021-12-23, V1.15.0
Get Software Products Statuses /{industry}/data-recipients/brands/softwareproducts/status V1 2021-10-29 2023-04-07 2021-10-29,V1.14.0 2021-12-23, V1.15.0
Get Data Recipient Statuses /{industry}/data-recipients/status V1 2021-10-29 2023-04-07 2021-10-29, V1.14.0 2021-12-23, V1.15.0
Get Data Recipients /{industry}/datarecipients V2 2021-10-29 2023-04-07 2021-10-29, V1.14.0 2021-12-23, V1.15.0

The standards Endpoint Version Schedule contains further details


This change was incorporated into release v1.17.0.

Please refer to Decision 237 for further details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

1 participant