ConsumerDataStandardsAustralia/standards-staging

Change previousDays data type to ‘[NaturalNumber]’ in Get Metrics AuthorisationMetricsV2.abandonmentsByStage

Closed this issue · 1 comments

anzbankau commented

Description
The data type of the numerous previousDays properties in Get Metrics AuthorisationMetricsV2.abandonmentsByStage is [integer], which permits negative integers. It should be [NaturalNumber] - in line with the accompanying elementary property currentDay.

Related Work Items
(Not applicable)

References

  1. CDS Support Portal guidance article: Get Metrics V5 abandonment by stages
nils-work commented

The x-cds-type values provided in the API specification files align to the types defined in the Common Field Types section.

Where these types are specified for values in arrays, they are not reflected in the generated documentation.

This change would ensure that the 'Type' being displayed for array properties refers to the x-cds-type field in the specification files instead of the generic type value.

Below is a sample of the changes -

Property Current base Type Updated to x-cds-type/Common Field Type
redirect_uris [string] [URIString]
key_ops [string] [ExternalRef]
accountIds [string] [ASCIIString]
productIds [string] [ASCIIString]
offsetAccountIds [string] [ASCIIString]
previousMonths [string] [RateString]
previousDays [string] [RateString]
currentDay [string] [RateString]
previousDays [integer] [NaturalNumber]