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

Enable generic links to schemas #400

Closed
nils-work opened this issue Jun 11, 2024 · 1 comment
Closed

Enable generic links to schemas #400

nils-work opened this issue Jun 11, 2024 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@nils-work
Copy link
Member

Description
The Standards template process currently generates anchor links to schemas including the version number, for example:
#cdr-banking-api_schemas_tocSbankingaccountv2 to refer to the Banking Account (V2) schema.

Where these links are used in general guidance, they will break when the schema version changes.

Related Work Items
Include additional anchor links excluding the version detail, so links used for general guidance (not related to a specific version) can remain valid, increasing the value of guidance and reducing maintenance.

@nils-work nils-work added the enhancement New feature or request label Jun 11, 2024
nils-work added a commit that referenced this issue Jun 11, 2024
@nils-work
Copy link
Member Author

The base schema anchor is derived from the current form:
#cdr-banking-api_schemas_tocSbankingaccountv2
becoming:
#cdr-banking-api_schema-base_bankingaccount
(replace '_schemas_tocS' with '_schema-base_' and remove vX at the end)

@nils-work nils-work added this to the v1.31.0 milestone Jun 11, 2024
CDR-API-Stream added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Jul 3, 2024
* 1.30.0 branch

* Updates to base build

* Update releasenotes.1.30.0.html.md

* Updated release notes templates

* Removed repeated object

* Removed duplicate TelcoAccount schema

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#634

* Create clean 1.31.0 branch

* Expanded nested array structure for previousDays

Addresses: ConsumerDataStandardsAustralia/standards-staging#396

* Remove redundant TelcoAccount object

* Update releasenotes.1.31.0.html.md

* Enable generic links to schemas

Addresses: ConsumerDataStandardsAustralia/standards-staging#400

* Updated Consumer Data Right link

Addresses: ConsumerDataStandardsAustralia/standards-staging#402

* Updated Obligation Date Schedule

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#615

* Removed title text

* Standards Maintenance Issue #640: Changed retirement date of Get Generic Plan Detail v2 and Get Energy Account Detail v3 to March 3rd 2025

* Standards Maintenance Issue #415: Clarified that a Token Introspection End Point response must include specific fields only for currently active tokens

* Standards Maintenance Issue #415: Corrected release notes change description

* Standards Maintenance Issue #415: Updated link to change in release notes

* Standards Maintenance Issue #415: Fixed spelling mistake in release notes

* Standards Maintenance Issue #633: Changes to CX and Security standards to clarify cdr_arrangement_id is requried for consent amendments

* Standards Maintenance Issue #633: minor presentation fixes

* Updated FDO table

Addresses: ConsumerDataStandardsAustralia/standards-staging#377

* Presentational styling of Banking documentation

Addresses: ConsumerDataStandardsAustralia/standards-staging#395

* Moved the March 2025 FDO to the 17th

* Standards Maintenance Issue #640: Moved release notes entry to Introduction section

* Standards Maintenance Issue #643: Allow data holders to depricate use of vulnerable TLS ciphers

* Standards Maintenance Issue #415: Made the word SHALL bold

* Fixed typo (#399)

Addresses: ConsumerDataStandardsAustralia/standards-staging#394

* Standards Maintenance Issue #643: Fixed typo in release notes

* Added MI19 DP link change log, re-ordered CRs in releasenotes

* In release notes, changed link to obligation date schedule for CR 615

* Build standards version 1.31.0 for staging

* Added change date in Change Log. Added None to release notes sections where there are no changes

* Rebuild version 1.31.0 in preparation of publishing

---------

Co-authored-by: Nils Berge <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant