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

softwareProductDescription should be marked as mandatory #525

Closed
CDR-DF opened this issue Jun 28, 2022 · 3 comments
Closed

softwareProductDescription should be marked as mandatory #525

CDR-DF opened this issue Jun 28, 2022 · 3 comments
Labels
Proposal made The DSB has proposed a specific change to the standards to address the change request Register

Comments

@CDR-DF
Copy link

CDR-DF commented Jun 28, 2022

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 client_description 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
Copy link
Collaborator

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 CDR-API-Stream added the Proposal made The DSB has proposed a specific change to the standards to address the change request label Aug 17, 2022
@CDR-API-Stream CDR-API-Stream moved this from Iteration Candidates to In Progress: Design in Data Standards Maintenance Aug 17, 2022
@CDR-API-Stream
Copy link
Collaborator

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@release/1.19.0...maintenance/525

@CDR-API-Stream CDR-API-Stream moved this from In Progress: Design to In Progress: Staging in Data Standards Maintenance Sep 7, 2022
@CDR-API-Stream
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Proposal made The DSB has proposed a specific change to the standards to address the change request Register
Projects
Archived in project
Development

No branches or pull requests

3 participants