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

Common Field Types enumerations versus customerUType and addressUType Schemas #583

Closed cuctran-greatsouthernbank closed 1 year ago

cuctran-greatsouthernbank commented 1 year ago

Description

The Common Field Types enum in the standard specifies that: String representing an option from a defined list of values

However, the enumerated Values for customerUType and addressUType in the Banking APIs Schemas are all in lower case.

image

image

The requirements in these areas therefore appear to be conflicting.

Area Affected

Banking APIs Schemas

Change Proposed

customerUType and addressUType enumerated values to be changed to Uppercase to be consistent with the Common Field Types enum.

Please note: this change will result in some technical changes for GSB to implement. Our current solution is compliant with the Schemas.

nils-work commented 1 year ago

Hi @cuctrangsb

You are correct that enums are upper case, but as these values specify a reference to a union object by field name, they follow a different style according to the Payload Conventions > Field Naming Style, and Object conventions - A specific convention will apply to union objects.

That convention is applied across the Standards, not just the Banking schemas.

nils-work commented 1 year ago

This issue will be considered as a query with an answer provided and scheduled to be closed on 19 May 2023 if there are no further comments or changes to the Standards expected as an outcome.