From de08cff3b922fc6d5b03c3836ca4e49abab431f1 Mon Sep 17 00:00:00 2001 From: Hemang Rathod Date: Tue, 1 Feb 2022 18:27:42 +1100 Subject: [PATCH 01/24] Standards Staging Issue #115: Update text description of bulk balance for energy in endpoint version schedule --- .../includes/endpoint-version-schedule/includes/_energy-dh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slate/source/includes/endpoint-version-schedule/includes/_energy-dh.md b/slate/source/includes/endpoint-version-schedule/includes/_energy-dh.md index 8fed8de7..c8fa7423 100644 --- a/slate/source/includes/endpoint-version-schedule/includes/_energy-dh.md +++ b/slate/source/includes/endpoint-version-schedule/includes/_energy-dh.md @@ -9,7 +9,7 @@ | Energy APIs | Get Agreed Payment Schedule | ``/energy/accounts/{accountId}/payment-schedule`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | | Energy APIs | Get Concessions | ``/energy/accounts/{accountId}/concessions`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | | Energy APIs | Get Balance For Energy Account | ``/energy/accounts/{accountId}/balance`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | -| Energy APIs | Get Bulk Balances (Energy) | ``/energy/accounts/balances`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | +| Energy APIs | Get Bulk Balances for Energy | ``/energy/accounts/balances`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | | Energy APIs | Get Balances For Specific Energy Accounts | ``/energy/accounts/balances`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | | Energy APIs | Get Invoices For Account | ``/energy/accounts/{accountId}/invoices`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | | Energy APIs | Get Bulk Invoices | ``/energy/accounts/invoices`` | GET | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A | From c4f27ca3a83970550d367c3e476e6292e0b96df7 Mon Sep 17 00:00:00 2001 From: Ivan Hosgood Date: Wed, 2 Feb 2022 15:17:43 +1100 Subject: [PATCH 02/24] Cleared out the diff comments presented on the Version Delta tab --- slate/source/includes/_admin.md.erb | 7 - slate/source/includes/_banking_apis.md.erb | 70 --------- slate/source/includes/_common_apis.md.erb | 29 ---- slate/source/includes/_energy_apis.md.erb | 90 ------------ slate/source/includes/_register.md.erb | 133 +----------------- slate/source/includes/_scopes.md.erb | 20 +-- .../includes/banking/_product_components.md | 9 -- .../includes/cx_standards/authorisation.md | 10 -- .../includes/cx_standards/data_language.md | 6 - .../includes/cx_standards/notifications.md | 3 - .../includes/cx_standards/withdrawals.md | 6 - .../nfrs/_availability-requirements.md | 4 - slate/source/includes/nfrs/_data-latency.md | 5 - slate/source/includes/nfrs/_data-quality.md | 13 -- slate/source/includes/nfrs/_definitions.md | 5 - .../source/includes/secondary/_energy_apis.md | 5 - .../includes/secondary/_energy_security.md | 9 -- slate/source/includes/secondary/_overview.md | 5 - .../security/_authentication_flows.md | 20 --- .../includes/security/_cdr_federation.md | 11 -- .../security/_certificate_management.md | 3 - .../security/_client_authentication.md | 10 -- .../security/_client_registration.md.erb | 8 -- slate/source/includes/security/_consent.md | 11 +- slate/source/includes/security/_overview.md | 9 -- .../security/_participant_statuses.md.erb | 5 - slate/source/includes/security/_references.md | 18 --- .../includes/security/_request_object.md | 3 - slate/source/includes/security/_tokens.md | 31 ---- .../endpoints/_cdr_arrangement_revocation.md | 29 +--- .../includes/security/endpoints/_jwks.md | 3 - .../includes/security/endpoints/_par.md | 16 --- slate/source/includes/standards/_errors.md | 7 - 33 files changed, 4 insertions(+), 609 deletions(-) diff --git a/slate/source/includes/_admin.md.erb b/slate/source/includes/_admin.md.erb index a55a9036..11e3605f 100644 --- a/slate/source/includes/_admin.md.erb +++ b/slate/source/includes/_admin.md.erb @@ -9,16 +9,9 @@ This provides an overview of CDS Administration Endpoints. Please note this API Admin Swagger (YAML) -```diff -Below are the changes to the Admin APIs section of the -standards. -The phrase `secondary responsibility requests` has been -replaced with `Shared Responsibility Data Requests` in -field descriptions. -``` <%= partial "includes/cds_admin.md" %> diff --git a/slate/source/includes/_banking_apis.md.erb b/slate/source/includes/_banking_apis.md.erb index cb3d9abc..a7d2fb32 100644 --- a/slate/source/includes/_banking_apis.md.erb +++ b/slate/source/includes/_banking_apis.md.erb @@ -10,76 +10,6 @@ This specification defines the APIs for Data Holders exposing Banking endpoints. Banking Swagger (YAML) -```diff -Below are the changes to the Banking APIs section of the -standards. - - -Bumped the version of the `Get Account Detail` endpoint (and associated -models) from v1 to v2. - - -Made the `loanEndDate`, `nextInstalmentDate` and `repaymentFrequency` -fields of the `BankingLoanAccountV2` model optional. - - -Bumped the version of the `Get Payees` endpoint (and associated -models) from v1 to v2. - - -Bumped the version of the `Get Payee Detail` endpoint (and associated -models) from v1 to v2. - - -Add the following enum value to the `type` query parameter for -the `Get Payees` endpoint: -+ DIGITAL_WALLET - - -Modified the description of the `type` field in the `BankingPayeeV2` model: -- The type of payee. DOMESTIC means a registered payee for domestic payments including NPP. INTERNATIONAL means a registered payee for international payments. BILLER means a registered payee for BPAY -to: -+ The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet -Also addition the following enum value to tye `type` field: -+ DIGITAL_WALLET - - -Add the following enum value to the `payeeUType` field in \ -the `BankingPayeeDetailV2` model: -+ digitalWallet - - -Added the `digitalWallet` field to the `BankingPayeeDetailV2` model. - - -Modified the `BankingProductV3` model to `BankingProductV4` and -amended the `additionalInformation` object as follows: - Add the `additionalOverviewUris` array - Add the `additionalTermsUris` array - Add the `additionalEligibilityUris` array - Add the `additionalFeesAndPricingUris` array - Add the `additionalBundleUris` array - - -Modified the description of the `x-fapi-auth-date` request header from: -- The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. -to: -+ The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls. - - -Updated the `BankingProductFeature` model to `BankingProductFeatureV2` -and added the following enum values: -+ CASHBACK_OFFER -+ EXTRA_REPAYMENTS -+ FRAUD_PROTECTION -+ GUARANTOR -+ INSTALMENT_PLAN -+ RELATIONSHIP_MANAGEMENT - - -Made the `x-fapi-auth-date` and `x-cds-client-headers` request headers conditional. - -``` <%= partial "includes/cds_banking.md" %> diff --git a/slate/source/includes/_common_apis.md.erb b/slate/source/includes/_common_apis.md.erb index fdaade74..25121947 100644 --- a/slate/source/includes/_common_apis.md.erb +++ b/slate/source/includes/_common_apis.md.erb @@ -10,35 +10,6 @@ This specification defines the Common APIs that apply to Data Holders multiple s Common Swagger (YAML) -```diff -Below are the changes to the Common APIs section of the -standards. -Bumped the version of the `Get Customer Detail` endpoint from v1 to v2. - - -The description of the 'physicalAddresses' array in both the -`CommonPersonDetail` model and the `CommonOrganisationDetail` model -changed from: -- Must contain at least one address. One and only one address may have the purpose of REGISTERED. Zero or one, and no more than one, record may have the purpose of MAIL. If zero then the REGISTERED address is to be used for mail -to: -+ Array is mandatory but may be empty if no valid addresses are held. One and only one address may have the purpose of REGISTERED. Zero or one, and no more than one, record may have the purpose of MAIL. If zero then the REGISTERED address is to be used for mail - - -`CommonPersonDetail` model updated to `CommonPersonDetailV2`. - - -`CommonOrganisationDetail` model updated to `CommonOrganisationDetailV2`. - -Modified the description of the `x-fapi-auth-date` request header from: -- The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. -to: -+ The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls. - - -Made the `x-fapi-auth-date` and `x-cds-client-headers` request headers conditional. - -``` - <%= partial "includes/cds_common.md" %> diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb index f3cfebd1..5150a1b2 100644 --- a/slate/source/includes/_energy_apis.md.erb +++ b/slate/source/includes/_energy_apis.md.erb @@ -4,102 +4,12 @@ This specification defines the APIs for Data Holders exposing Energy endpoints. -```diff -Removed the statement of non-binding for energy -```
Energy Swagger (JSON)
Energy Swagger (YAML)
-```diff -Below are the changes to the Energy APIs section of the -standards. - -The description for the `EnergyPlanControlledLoad` model -was changed from: -- Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD -to: -+ Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD - - -The title of the bulk balances API changed from: -- Get Bulk Balances (Energy) -to: -+ Get Bulk Balances for Energy - - -The enum values for the `tariffUType` field in the -`EnergyPlanSolarFeedInTariff` model changed from: -- GOVERNMENT -- RETAILER -to: -+ singleTariff -+ timeVaryingTariffs - - -Made the `dailySupplyCharges` in the `EnergyPlanTariffPeriod` model -optional rather than mandatory. - - -Added the `type` enumeration field to the following: - `EnergyPlanTariffPeriod` model - `otherCharges` object in the `EnergyInvoiceGasUsageCharges` model - `otherCharges` object in the `EnergyInvoiceElectricityUsageCharges` model - `EnergyBillingOtherTransaction` model -The `type` field has the following enumeration values; -+ ENVIRONMENTAL -+ REGULATED -+ NETWORK -+ METERING -+ RETAIL_SERVICE -+ RCTI -+ OTHER - - -Added the `measureUnit` enumeration field to the following: - `singleRate` object in the `EnergyPlanTariffPeriod` model - `timeOfUseRates` object in the `EnergyPlanTariffPeriod` model - `demandCharges` object in the `EnergyPlanTariffPeriod` model - `EnergyBillingUsageTransaction` model -The `measureUnit` field has the following enumeration values; -+ KVA -+ KVAR -+ KVARH -+ KW -+ DAYS -+ METER -+ MONTH - - -Addition of `startDate` and `endDate` fields to the -`EnergyBillingOtherTransaction` model. - - -Modified the description of the `dailySupplyCharges` field from: -- The amount of access charge for the tariff period, in cents per day exclusive of GST. -to: -+ The amount of access charge for the tariff period, in dollars per day exclusive of GST. - - -Modified the description of the `generalUnitPrice` field from: -- The block rate (unit price) for any usage above the included fixed usage, in cents per kWh inclusive of GST. Only required if pricingModel field is ‘QUOTA’ -to: -+ The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST. Only required if pricingModel field is ‘QUOTA’ - - -Made the `x-cds-client-headers` and `x-fapi-auth-date` headers conditional. - -Added additional errors for 404 status code: - urn:au-cds:error:cds-energy:Authorisation/InvalidEnergyAccount - urn:au-cds:error:cds-energy:Authorisation/UnavailableEnergyAccount - urn:au-cds:error:cds-energy:Authorisation/InvalidServicePoint - urn:au-cds:error:cds-energy:Authorisation/UnavailableServicePoint - -Removed references to hardship in descriptions. - -``` <%= partial "includes/cds_energy.md" %> diff --git a/slate/source/includes/_register.md.erb b/slate/source/includes/_register.md.erb index 124b618b..be91fcf2 100644 --- a/slate/source/includes/_register.md.erb +++ b/slate/source/includes/_register.md.erb @@ -1,20 +1,8 @@ # Register APIs -```diff -The statement: -- This following provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata. -changed to: -+ This following provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata exclusively for the banking sector. -``` This following provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata exclusively for the banking sector. These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients. -```diff -The phrase: -- ...Data Recipient Software Productss are required... -corrected to: -+ ...Data Recipient Software Products are required... -```