ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

softwareProductDescription should be marked as mandatory #525

Closed CDR-DF closed 1 year ago

CDR-DF commented 2 years ago

Description

In the SoftwareProductMetaData schema, the softwareProductDescription field is marked as "optional". However, in the SSA Definition (https://consumerdatastandardsaustralia.github.io/standards/#client-registration) section, the _clientdescription field (that maps to the softwareProductDescription field) is marked as "Required".

Area Affected

Register APIs -> Get Data Recipients

Change Proposed

Mark the softwareProductDescription field of the SoftwareProductMetaData schema as "mandatory".

DSB Proposed Solution

The current DSB proposal for this issue is in this comment.

CDR-API-Stream commented 1 year ago

This appears to be a reasonable change request. If the SSA setting of required is valid then the value will be always available so making the value mandatory in the software products API should have no implementation impact.

As a result, the current proposed solution is to adopt the change as proposed in the Change Proposed section of the issue.

Feedback is sought to identify if the assumption that this will have zero implementation impact and would not be a breaking change. If there is feedback that this assumption is incorrect then the proposed solution will be revisited.

CDR-API-Stream commented 1 year ago

This change has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.19.0...maintenance/525

CDR-API-Stream commented 1 year ago

This change has been updated to target v1.20.0: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.20.0...maintenance/525