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

Inconsistency of data types in various schema #575

Closed
nils-work opened this issue Jan 24, 2023 · 2 comments
Closed

Inconsistency of data types in various schema #575

nils-work opened this issue Jan 24, 2023 · 2 comments
Labels
Schema Issues related to schema.
Milestone

Comments

@nils-work
Copy link
Member

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

biza-io commented May 30, 2023

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).

@CDR-API-Stream CDR-API-Stream moved this from Iteration Candidates to In Progress: Staging in Data Standards Maintenance Jun 29, 2023
@nils-work nils-work added this to the 1.25.0 milestone Jul 10, 2023
@nils-work
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Schema Issues related to schema.
Projects
Status: Done
Development

No branches or pull requests

3 participants