Skip to content

Commit

Permalink
Merge pull request #440 from ConsumerDataStandardsAustralia/defect/437
Browse files Browse the repository at this point in the history
Staging #437 - Remove Known Issues
  • Loading branch information
nils-work authored Oct 21, 2024
2 parents a80ef07 + fcced3d commit 6fe10d7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 4 additions & 5 deletions slate/source/includes/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Known Issues



There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.

```diff
Removed three known issues related to Register endpoint specfications that are resolved
```

Issue | Description
:---- | :----------
Register APIs use local version of common definitions | The Register APIs use a locally defined version of common schema definitions such as `ResponseErrorList` for error responses. These need to be updated to reference common swagger specifications inherited by the Common Swagger spec.
Register APIs use different field type definitions | The Register APIs define their own field types that are not consistent with the [Common Field Types](#common-field-types) defined in the data standards. As part of porting the Register standards across to the primary data standards, the field types need to be re-aligned to use the common field type definitions. For example, `string (data-time)` should be changed to `DataTime` and `integer(int32)` should be changed to `PositiveInteger`.
DCR and Register Swagger naming conventions | The DCR and Register naming conventions are not consistent with the broader data standards. Field names should be standardised to camelCase and snake_case inline with the data standards
None | N/A


## Future improvements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This release addresses the following minor defects raised on [Standards Staging]
- [Standards Staging #418 - Add a link to CX Guidelines to the left menu pane of the Standards](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/418)
- [Standards Staging #419 - Field name styling](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/419)
- [Standards Staging #426 - Error in Telco OAS components](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426)
- [Standards Staging #437 - Remove Known Issues](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/437)
- [Standards Staging #438 - Improve code sample section styling](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/438)

This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
Expand Down Expand Up @@ -98,3 +99,4 @@ This release addresses the following Decision Proposals published on [Standards]
## Known Issues
|Change|Description|Link|
|------|-----------|----|
| Remove Known issues | [**Standards Staging #437**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/437): Removed three known issues related to Register endpoint specfications that are resolved | [Known Issues](../../#known-issues)

0 comments on commit 6fe10d7

Please sign in to comment.