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

Properties in BankingTransactionDetail objects #414

Closed nils-work closed 1 year ago

nils-work commented 2 years ago

Description

The swagger JSON and the documentation of properties in the BankingTransactionDetail schema seem to be misaligned.

Area Affected

BankingTransactionDetail extendedData schema documentation and related Swagger objects.

Change Proposed

The extendedDescription property shows as x-conditional in the BankingTransactionDetail_extendedData object (but it's not present there), and also shows as required in the BankingTransactionDetail_extendedData_x2p101Payload object (where the property is actually present).

The standards documentation shows that field as mandatory, but the Description includes a condition - An extended string description. Only present if specified by the extensionUType field

image

Can these details be clarified?

image

DSB Proposed Solution

The current DSB proposal for this issue is in this comment

CDR-API-Stream commented 2 years ago

This appears to be a defect and it is proposed that it is simply fixed according to the Change Proposed section of the issue.

CDR-API-Stream commented 2 years ago

This change has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.19.0...maintenance/414

CDR-API-Stream commented 1 year ago

This change has been updated to target v1.20.0: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.20.0...maintenance/414