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

Maintenance Iteration 15 Holistic Feedback #586

Closed
CDR-API-Stream opened this issue Apr 26, 2023 · 16 comments
Closed

Maintenance Iteration 15 Holistic Feedback #586

CDR-API-Stream opened this issue Apr 26, 2023 · 16 comments
Milestone

Comments

@CDR-API-Stream
Copy link
Collaborator

CDR-API-Stream commented Apr 26, 2023

This change request has been created to simplify the raising of minor changes, such as text corrections or description clarifications, that are not really material to the standards but do have a real impact on readability and clarity.

Please raise any such suggestions that you would like included in Maintenance Iteration 15 and the DSB will review them. If a suggestion is a material change a dedicated CR will be raised.

@HemangCDR
Copy link

Following energy APIs should be listed with the POST instead of GET method in the endpoint version schedule:

  • Get Usage For Specific Service Points
  • Get Balances For Specific Energy Accounts

@CDR-API-Stream
Copy link
Collaborator Author

The following hygiene tasks are planned for this iteration:

  • Clean up the future dated obligations table where obligations are greater than six months in the past.
  • Clean up of FAPI 1.0 references. This has been broken out as a standalone CR. See Remove FAPI 1.0 draft references #590

@markverstege
Copy link
Contributor

Following energy APIs should be listed with the POST instead of GET method in the endpoint version schedule:

  • Get Usage For Specific Service Points
  • Get Balances For Specific Energy Accounts

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@2083b3f

Note it is compared against the previous release. At present no draft 1.25.0 release has been staged but it is expected this change will target 1.25.0 for release at the end of maintenance iteration 15.

@markverstege
Copy link
Contributor

The following hygiene tasks are planned for this iteration:

  • Clean up the future dated obligations table where obligations are greater than six months in the past.
  • Clean up of FAPI 1.0 references. This has been broken out as a standalone CR. See Remove FAPI 1.0 draft references #590

The clean up of future dated obligations has been staged for review: ConsumerDataStandardsAustralia/standards-staging@2083b3f

Note it is compared against the previous release. At present no draft 1.25.0 release has been staged but it is expected this change will target 1.25.0 for release at the end of maintenance iteration 15.

@markverstege
Copy link
Contributor

Add the CDR Register hosted "Get Data Holder Brands Summary" API into the Endpoint Version Schedule.

@markverstege
Copy link
Contributor

Add the CDR Register hosted "Get Data Holder Brands Summary" API into the Endpoint Version Schedule.

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@8670eb6

The Data Holder APIs have been grouped together for readability.

@nils-work
Copy link
Member

There are two minor typos in the Endpoint Version Schedule introductory text:

Binding Date indicates the dates date the particular version of an endpoint becomes binding in the data standards.

Retirement Date indicates, where relevant, denotes the date a specific version can be retired and is no longer supported. All consumers of the affected endpoint must upgrade to a more recent version currently available.

@markverstege
Copy link
Contributor

There are two minor typos in the Endpoint Version Schedule introductory text:

Binding Date indicates the dates date the particular version of an endpoint becomes binding in the data standards.

Retirement Date indicates, where relevant, denotes the date a specific version can be retired and is no longer supported. All consumers of the affected endpoint must upgrade to a more recent version currently available.

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@5727ad3

@nils-work
Copy link
Member

For consistency with the Standards, consider the following Endpoint Version Schedule 'Section' name updates:

  • change InfoSec Profile to Security Profile in three places
  • change CDR Register APIs to Register APIs in the title and rows of that table.

markverstege added a commit to ConsumerDataStandardsAustralia/standards-staging that referenced this issue May 22, 2023
@markverstege
Copy link
Contributor

For consistency with the Standards, consider the following Endpoint Version Schedule 'Section' name updates:

  • change InfoSec Profile to Security Profile in three places
  • change CDR Register APIs to Register APIs in the title and rows of that table.

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@f1bfaa3

@nils-work
Copy link
Member

There's a typo in this line in the FDO section -

This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter.

@markverstege
Copy link
Contributor

There's a typo in this line in the FDO section -

This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter.

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@85ddc8a

@nils-work
Copy link
Member

Correct the typo in this text in the introduction of the Get Products endpoint -

and one refers to an account that actual actually has been instantiated

@perlboy
Copy link

perlboy commented Jun 5, 2023

Add note that AER hosted APIs are currently non-compliant with any version of Get Generic Plan Detail. Not putting a note to this effect makes the published standards in the area of Generic Plan detail very misleading.

markverstege added a commit to ConsumerDataStandardsAustralia/standards-staging that referenced this issue Jun 23, 2023
@markverstege
Copy link
Contributor

Correct the typo in this text in the introduction of the Get Products endpoint -

and one refers to an account that actual actually has been instantiated

This change has been staged for review: ConsumerDataStandardsAustralia/standards-staging@6f0e8ca

JamesMBligh added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Jul 10, 2023
* Standards Maintenance Issue 546: Updated DCR and Register swagger specifications to use Common Field Types

* Added diff and release notes

* Fixed redirect_uris array use of URIString in relation to maintenance comment: ConsumerDataStandardsAustralia/standards-maintenance#546 (comment)

* Updated code formatting and indenting

* Added Enum common type usage

* Updated DCR and Register specs based on community feedback to the Common Field Types implementation

* Updated swaggers to remove format fields

* Updated diff for the Register API changes

* Fixed formatting

* Updated Register APIs based on ACCC feedback

* Base branch for v1.22.0

* Draft updates 1 DP 275

* Retain v1.21.0 delta statements

* Rebuild

* Fixed open-status reversal

* Rebuild

* Create release notes
Add archive entry
Add change log entry

* Release notes

* Add archived API versions

* Add new field to the swagger
Add FDO
Update endpoint schedule

* Add diff statements

* Fix missing obselete link in Get Accounts

* Fix obselete message bug

* Fixed Issue with AccontDetail

* Rebuild
Add in Telco diff statement
Add Telco release notes

* Merge of 1.22.0

* Remove external refs on client IDs

* Remove common string references

* Review updates

* Release notes

* Rebuild
Diff statement

* Updates to x-v headers

* reverted account scope

* Updated other account scopes

* Update extended security documentation

* Rebuild

* Engage Festive

* Rebuild with FESTIVE ENGAGED

* Fix additional TDIF links

* Fix ACCC fonts

* Fix minor defects picked up after publish
Rebuild

* - Update version to 1.22.1
- Remove diff statements
- Add links for archive
- Add draft release notes

* Removed santa hat

* Restored diff overview statement
Removed last actual diff statement

* Full rebuild

* Add binding statement

* Add diff and release notes

* Fix diff typo

* Fix FDOs
Fix Obligation table
Add release notes

* Update

* Fix the binding date for Get Energy Account Detail V2
Removed the TBC dates for v1.19.0
Release notes

* Rebuild

* Update end point version schedule links
Release notes

* Changed error model for energy to ResponseErrorListV2
Rebuild

* Fixed typo
Rebuild

* Update release notes for 227

* Rebuild

* Added release notes for Telco

* Apply energy changes to SDH swagger also

* Rebuild

* Fix error model in Telco
Fix release note types
Rebuild

* Update V2 error list (#267)

* Fix Telco merge
Rebuild

* Rebuild

* Fix publish date
Rebuild

* Base branch for 1.23.0

* Standards Maintenance Issue #576: Update security profile sections allowing ID token encryption when using ACF

* Updated DCR spec to treat ID token encryption claims as conditional

* Standards Maintenance Issue #576: Removed Additional Note for v1.22.0 from version delta notes

* Rebuild

* Rebuild

* Rebuild

* Squashed 1.23.0 changes

* Create v1.24.0 branch

* Remove errant diff statements

* Rebuild

* Standards Maintenance Issue #565: Updated wording and corrected a typo in the 'Issued by the Register CA for Data Recipients' table. Corrected a typo in the 'CDR Certificate Authority' section. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Corrected spelling mistake in description of RejectionMetricsV2.unauthenticated field. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Fixed description of BankingAccountDetailV3.lendingRates field. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Minor corrections. Addresses comments ConsumerDataStandardsAustralia/standards-maintenance#565 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#565 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance 535: Updated Private Key JWT client authentication requirements

* Updated release version to 1.24.0

* Standards Maintenance Issue #565: Updated description of 'period' paramater in Get Metrics API. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Updated description of 'PENSION_RECIPIENT' values in Product & Account Components section. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Added statements noting CORS is not required for relevant security endpoints and Register and DCR APIs. Addresses ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance 532: Updated Customer API to align x-fapi-auth-date definition

* Standards Maintenance Issue #565: Listed specific APIs in the 'Unattended' section. Fixed incorrect Energy API names. Addresses ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #565: Updated description of SecondaryHolderMetrics.rejections. Addresses ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Corrected typos

* Standards Maintenance Issue #520: Added 'rates' object to EnergyPlanSolarFeedInTariff structure. Incremented versions of Get Generic Plan Detail and Get Energy Account Detail APIs

* Standards Maintenance Issue #520: Added archieve files for Get Energy Account Detail and Get Generic Plan Detail APIs

* Standards Maintenance Issue #565: Added actual % values represented by examples for 'RateString' field type. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#565 (comment)

* Standards Maintenance Issue #574: Added new Authorisation CX Standard for additional account selection functionality in the authorisation flow

* Corrected requirements for the Large Payload tier

* Standards Maintenance Issue #496: Removed x-fapi-interaction-id from response headers of Get Energy Plans and Get Energy Plan Details public APIs

* Standards Maintenance Issue #496: Added link to CR in release notes

* Standards Maintenance Issue #574: Added link to CR in release notes

* Standards Maintenance Issue #520: Added link to CR in release notes

* Standards Maintenance Issue #565: Added link to CR in release notes

* Standards Maintenance Issue #577: Made various changes to the Certificate Signing Request Profile table. Removed the Test Environment details from the Certificate Trust Model section

* Rebuild
Update versions
Remove date TBCs
Fixed typo in diff statement
Reordered FDOs by date

* Rebuild

* Rebuild to correctly create swagger markdown

* Update change log
Rebuild

* Updated non-normative examples demonstrating Authorisation Code Flow with JARM to include the response_mode parameter

* Removed legacy FAPI refrences and outdated phasing requirements

* Holistic changes for MI15 including removing legacy FDOs and correcting the HTTP method for Energy APIs

* Added Get Data Holder Brands Summary into the Endpoint Version Schedule

* Corrected typos in the endpoint version scheule. This addresses the comment: ConsumerDataStandardsAustralia/standards-maintenance#586 (comment)

* Renamed headings in the endpoint version schedule to align with the standards. Addresses the following comment: ConsumerDataStandardsAustralia/standards-maintenance#586 (comment)

* Update for #536

* Added ref to BankingDigitalWalletPayee

* Draft changes for #585

* Standards Maintenance 522: Added all metadata parameters required in upstream specs

* Removed legacy list

* Standards Maintenance 586: Fixed spelling of 'Register'. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#586 (comment)

* Create base v1.25.0 release with versions updated and previous diffs removed

* Rebuild

* Updates for #413

* Minor formatting corrections to release notes

* Updates for #575

* Standards Maintenance Issue #591: Updated description of EnergyPaymentSchedule.isTokenised to further clarify when it can be used

* Standards Maintenance Issue #592: Added new ENUM values to EnergyBillingDemandTransaction.timeOfUseType and EnergyBillingUsageTransaction.timeOfUseType fields

* Minor fixes for PositiveInteger / x-v optionality

* Updated MUST requirements for JARM authorisation response encryption

* Updated formatting for the OIDD non-normative example

* Standards Maintenance 586: Fixed typo in Get Products API description. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#586 (comment)

* Minor Fix for Durations

* Standards Maintenance Issue #592: Incremented versions of Get Billing For Account, Get Bulk Billing and Get Billing For Specific Accounts APIs

* Standards Maintenance Issue #592: Added archive files for v1 of Get Billing For Account, Get Billing For Specific Accounts and Get Bulk Billing APIs

* Standards Maintenance Issue #536: Versioned Get Payments For Specific Accounts, Get Scheduled Payments for Account and Get Scheduled Payments Bulk endpoints

* Standards Maintenance Issue #536: Updated description of name field in digital wallet structures of telco and energy. Updated releasenotes

* Standards Maintenance Issue #536: Fixed dates in FDO table and endpoint version schedule

* Standards Maintenance Issue #592: Fixed retirement date for Get Billing For Specific Accounts in endpoint version schedule

* Fix ISO link

* Amend as per Decision 303

* Release notes

* Interim commit

* Rebuild

* Finished Get Metrics v4

* Finished 288

* Fix publish date
Fix MI15 DP number
Rebuild

* Dependabot updates

* Move telco standards to a sub-page as a candidate standard

* Add in additional standards section

* Format fixes for diffs

* Full rebuild

* Fixed minor typos in the FDO and endpoint version schedule dates

* Fixed markdown typos

* Fixed markdown issues

* Rebuild and correct previous 1.24.0 merge

* Additional typo

---------

Co-authored-by: Mark Verstege <2514377+markverstege@users.noreply.github.com>
Co-authored-by: Kirkycdr <brian.kirkpatrick@consumerdatastandards.gov.au>
Co-authored-by: kirkycdr <91938516+kirkycdr@users.noreply.github.com>
Co-authored-by: Hemang Rathod <hemang.rathod@consumerdatastandards.gov.au>
@nils-work nils-work added this to the 1.25.0 milestone Jul 10, 2023
@nils-work
Copy link
Member

Standards version 1.25.0 has now been published, incorporating this set of changes.

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

No branches or pull requests

5 participants