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.

Sign up for GitHub

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

Jump to bottom

Field name styling #419

Closed
nils-work opened this issue Aug 16, 2024 · 2 comments
Closed

Field name styling #419

nils-work opened this issue Aug 16, 2024 · 2 comments
Assignees
@nils-work
Labels
enhancement New feature or request
Milestone
v1.32.0

Comments

@nils-work
Copy link
Member

Add consistent styling for referenced field names in the Banking Standards, DP306 Candidate and NBL Candidate, for the following text -

- Filter on the payee type field. In addition to normal type field values
+ Filter on the payee _type_ field. In addition to normal _type_ field values
- effectiveFrom and effectiveTo
+ _effectiveFrom_ and _effectiveTo_

and other field references in the Product & Account Components section.
@nils-work nils-work added the enhancement New feature or request label Aug 16, 2024
@nils-work nils-work self-assigned this Aug 16, 2024
nils-work added a commit that referenced this issue Aug 28, 2024
@nils-work
Staging #419 - Update field name styling
e62b947 
Addresses: #419
@nils-work nils-work mentioned this issue Aug 28, 2024
Merged
@nils-work nils-work added this to the v1.32.0 milestone Aug 28, 2024
@nils-work
Copy link
Member Author

Also includes updating -

  • "accountIds" to "accountId values"
  • "ID of the account" to "accountId of the account"
  • "account ID" to "accountId"

and a correction to an incorrectly structured field in the RequestAccountIds schema (the value was not previously rendered in documentation) -

- "description": "Array of specific accountIds to obtain authorisations for.",
+ "description": "Array of _accountId_ values.",

Changes staged here.

nils-work added a commit that referenced this issue Oct 21, 2024
@nils-work
Merge pull request #425 from ConsumerDataStandardsAustralia/defect/419
2819ce4 
Staging #419 - Update field name styling
nils-work added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Oct 21, 2024
@nils-work @markverstege @HemangCDR
Release/1.32.0 (#358)
2a69040 
* Created 1.32.0 branch base

* Updated to newer openapi-generator-cli

Added new jar and removed older jars

* Merged the Change Log and Archives sections

Addresses: ConsumerDataStandardsAustralia/standards-staging#413

* Retaining original anchors

* Fixed spelling mistake for authorization_code reference. Addresses issue comment ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Removed redundant statement regarding client ID. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Corrected field description for tariffUType. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Updated URIString example to use HTTPS scheme rather than HTTP. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Update details in Common Field Types section

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Clarified the format of adjustment rate values

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Fixed typos

Addresses: ConsumerDataStandardsAustralia/standards-staging#411

* Endpoint as one word

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#527 (comment)

* Corrected required properties

Addresses: ConsumerDataStandardsAustralia/standards-staging#417

* Add version delta comment and removed line breaks

* #418 - Add CX guidelines link to footer

Addresses: ConsumerDataStandardsAustralia/standards-staging#418

* Update Common and Admin APIs descriptions

* Staging #419 - Update field name styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#419

* Update description of Product Categories section

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Staging #426 - Corrected OAS, moved files

Addresses: ConsumerDataStandardsAustralia/standards-staging#426

* Fixed typos

* Standards Maintenance Issue #652: Updated description of AmountString field clarifying the currency format and noting it defaults to AUD

* adding 'and'

for one hundred 'and' twenty-three dollars

* Minor update to styling and wording

* Fix link for local build testing

* Added x-version-notes and x-diff custom extension keys. x-version-notes allows capturing API version notes. x-diff allows capturing diff statements against specific API or schemas

* Standards Maintenance Issue #653: Amended description of dailySupplyChargeType field

* Standards Maintenance Issue #653: Fixed incorrect diff statement

* Staging #438 - Improve code samples

Addresses: ConsumerDataStandardsAustralia/standards-staging#438

* Version delta and release notes

* Staging #437 - Remove Known Issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#437

* Corrected error title

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Update _errors.md

* Corrected quotes in JSON samples

* Added Register Base URLs to spec

* Updated links

* Added TLS changes to align with BCP 195 and FAPI 2.0. Addresses issue: ConsumerDataStandardsAustralia/standards-maintenance#648

* Removed x-diff custom key from json swagger. Moved diff statement into energy erb file

* BCP195 as one word, bolded key words

* Update "account id" to "accountId"

* Removed bold styling

* Update to validation version only

Clearly distinguishing the specific JAR versions used in each step of the build process and updated to the newer JAR for validation only.

* Reverted non-RateString changes

* Updated notes

* Update issue title

* Resolve release notes and change log

* 1.32.0 build for Staging

* Build 1.32.0

---------

Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
@nils-work
Copy link
Member Author

Incorporated into Standards v1.32.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nils-work nils-work

Labels
enhancement New feature or request
Projects
None yet
Milestone
v1.32.0
Development

No branches or pull requests
1 participant
@nils-work