search

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

Inconsistency of data types in various schema #575

Closed nils-work closed 12 months ago

nils-work commented 1 year ago

Description

There are minor differences in how some header types are defined in the Register API Specification, compared to Banking and others.

Area Affected

For example:

Register: Get Data Holder Brands

x-v, x-min-v, page and page-size appear as integer:

image

The corresponding sample reflects the integer type:

image

Banking: Get Accounts

x-v and x-min-v appear as string, while page and page-size appear as PositiveInteger.

image

The corresponding sample reflects the string type:

image

Change Proposed

Agree on the most appropriate convention and apply it consistently.

biza-io commented 1 year ago

Biza supports the alignment of specifications between the CDR Data APIs and the Register. Specifically we recommend aligning as follows:

  1. Adopt page and page-size as PositiveInteger which we believe to be most appropriate and for which error handling behaviour is nuanced based on this (Invalid Field vs. Invalid Page)
  2. The headers should be aligned to a string as this is aligned to the upstream standard governing headers (ie. HTTP 1.0/1.1).
nils-work commented 12 months ago

Standards version 1.25.0 has now been published, incorporating this change.