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

Improve code sample section styling #438

Closed
nils-work opened this issue Sep 17, 2024 · 4 comments
Closed

Improve code sample section styling #438

nils-work opened this issue Sep 17, 2024 · 4 comments
Labels
enhancement New feature or request
Milestone
v1.32.0

Comments

@nils-work
Copy link
Member

The 'Code samples' sections generated in the Standards template currently appear to have missing lines and inconsistent styling. These can be resolved to improve readability and reduce the space they occupy in the page.

Current example:
image

Updated:
image
@nils-work nils-work added the enhancement New feature or request label Sep 17, 2024
@nils-work nils-work added this to the v1.32.0 milestone Sep 17, 2024
@nils-work
Copy link
Member Author

Also adds the ability for a servers[0].url property of an operation to override the default server in the examples.

nils-work added a commit that referenced this issue Sep 17, 2024
@nils-work
Staging #438 - Improve code samples
f9c79d5 
Addresses: #438
@nils-work nils-work mentioned this issue Sep 17, 2024
Merged
@nils-work
Copy link
Member Author

This has been staged.

@nils-work
Copy link
Member Author

This change will also replace the servers[...].url defined in the Register spec: https://<register-base-url>/ with the actual server for the respective endpoints.

TLS endpoints: https://api.cdr.gov.au
MTLS endpoints: https://secure.api.cdr.gov.au

@nils-work nils-work mentioned this issue Sep 26, 2024
Open
nils-work added a commit that referenced this issue Oct 21, 2024
@nils-work
Merge pull request #439 from ConsumerDataStandardsAustralia/defect/438
a80ef07 
Staging #438 - Improve code samples
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
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
v1.32.0
Development

No branches or pull requests
1 participant
@nils-work