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

Enum parameters in endpoints are not reflected correctly #349

Closed
nils-work opened this issue Dec 14, 2023 · 1 comment
Closed

Enum parameters in endpoints are not reflected correctly #349

nils-work opened this issue Dec 14, 2023 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@nils-work
Copy link
Member

Parameters such as product-category and open-status in Banking APIs > Get Accounts appear as Type string in documentation, but they are defined in the specification with a list of possible enum values.

These should appear as Enum with a link to the Common Field Types section to provide clarity and match similar types in response schemas.

@nils-work nils-work added the enhancement New feature or request label Dec 14, 2023
nils-work added a commit that referenced this issue Dec 18, 2023
@nils-work nils-work added this to the v1.29.0 milestone Dec 18, 2023
@nils-work
Copy link
Member Author

Where parameter values provided in the API specification files are defined as enum, they are not reflected as such in the generated documentation.

This change would ensure that the 'Type' being displayed correctly refers to the 'Enum' type and references the Common Field Types description instead of the generic string value.

Below is a sample of the changes -

Name In Current base Type Corrected Type
industry path string Enum
product-category query string Enum
open-status query string Enum
type query string Enum
effective query string Enum
fuelType query string Enum
interval-reads query string Enum
period query string Enum

@nils-work nils-work mentioned this issue Dec 20, 2023
JamesMBligh added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Dec 21, 2023
* Create clean version of release 1.29.0

* Added releasenotes file for 1.29.0

* Added redirect_uri

* Update CX Guidlines link

* Removed amending authz

* added RFC7636 to refs

* Updated Intro DSB link

* Differences in naming of Register endpoints

* Added obligation schedule to FDO

* Updated desc of minimumValue maximumValue unitOfMeasure

* Updated markdown of minimumValue maximumValue unitOfMeasure

* Added missing fields for PAID_OUT_AT_MATURITY ROLLED_OVER for maturityInstructions

* Updated definition of Number in common field types

* Updated descriptions on ErrorMetricsV2

* Modified URL in line with request example

* url encoded

* Retain Version Delta for Additional Standards

Re-added the 1.28.0 Version Delta comments for the Candidate and Draft Standards recently updated and still under consultation in 1.29.0.

* Added authorization_signed_response_alg & authorization_encrypted_response_alg as conditional

* Resolve link and navigation issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Switch tracking and add Standards category ribbon

Addresses: ConsumerDataStandardsAustralia/standards-staging#334, ConsumerDataStandardsAustralia/standards-staging#332

* Corrected minor typos only

Addresses typos: ConsumerDataStandardsAustralia/standards-staging#312

* Remove resource name to reduce length + complexity

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Added end &

* Removed FDO Obligation date from Amending authorisation

* Created a single link for [PKCE] / [RFC7636]

* Standards Maintenance Issue #587: Added new field measureUnit in EnergyBillingDemandTransaction

* Adjust heading levels and add navigation classes

Addresses: ConsumerDataStandardsAustralia/standards-staging#338

* Identifying superseded versions in obsolete path

Addresses: ConsumerDataStandardsAustralia/standards-staging#334

* Business Consumer Provisions

Addresses: #333

* Added link to change description

* Added link to change description

* Standards Maintenance Issue #587: Fixed typos. Re-arranged order of api versions for consistency

* Add style to override class for CX submenu items

* Added Data Holder Dashboards section

Addresses: #334

* Added link to issue

* Added issue link to description

* Added issue link to description

* Updated with data attribute to apply CSS

* Updated with data attribute

* Added FDO details

* Standards Maintenance Issue #613: Changed type of time fields in energy plan data to ExternalRef referring to ISO 8601 Times specification

* Standards Maintenance Issue #613: Changed description of affected time fields for clarity.

* Standards Maintenance Issue #587: Fixed typos

* Standards Maintenance Issue #587: Fixed typo in FDO table

* Retaining majority of useful original anchors

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Display the x-cds-type for array items

Addresses: ConsumerDataStandardsAustralia/standards-staging#348

* Show format of request parameter enums correctly

Addresses: ConsumerDataStandardsAustralia/standards-staging#349

* Adding release notes and delta comments

Update for: ConsumerDataStandardsAustralia/standards-staging#348

* Update to release notes and NBL version delta

* Remove last diffs

* Moving NBL Draft to Candidate Standards

Addresses: #318

* Rebuild

* Add FDO diff statement for 587

* Add diff statements and release notes

* Add diff and release notes

* Add release note reference to CR620

* Add release notes

* Add santa hat

* Update release date

* Fix release notes
Update obligation date counts

* Corrected typo

* Add MI 17 DP to release notes

Addresses: #328

* Updated links

* Updated dates

* Added deprecation dates

* Corrected typo

* Rebuild

* Update change log with DP328

---------

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: kirkycdr <[email protected]>
Co-authored-by: Nils Berge <[email protected]>
JamesMBligh added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Jan 18, 2024
* Create clean version of release 1.29.0

* Added releasenotes file for 1.29.0

* Added redirect_uri

* Update CX Guidlines link

* Removed amending authz

* added RFC7636 to refs

* Updated Intro DSB link

* Differences in naming of Register endpoints

* Added obligation schedule to FDO

* Updated desc of minimumValue maximumValue unitOfMeasure

* Updated markdown of minimumValue maximumValue unitOfMeasure

* Added missing fields for PAID_OUT_AT_MATURITY ROLLED_OVER for maturityInstructions

* Updated definition of Number in common field types

* Updated descriptions on ErrorMetricsV2

* Modified URL in line with request example

* url encoded

* Retain Version Delta for Additional Standards

Re-added the 1.28.0 Version Delta comments for the Candidate and Draft Standards recently updated and still under consultation in 1.29.0.

* Added authorization_signed_response_alg & authorization_encrypted_response_alg as conditional

* Resolve link and navigation issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Switch tracking and add Standards category ribbon

Addresses: ConsumerDataStandardsAustralia/standards-staging#334, ConsumerDataStandardsAustralia/standards-staging#332

* Corrected minor typos only

Addresses typos: ConsumerDataStandardsAustralia/standards-staging#312

* Remove resource name to reduce length + complexity

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Added end &

* Removed FDO Obligation date from Amending authorisation

* Created a single link for [PKCE] / [RFC7636]

* Standards Maintenance Issue #587: Added new field measureUnit in EnergyBillingDemandTransaction

* Adjust heading levels and add navigation classes

Addresses: ConsumerDataStandardsAustralia/standards-staging#338

* Identifying superseded versions in obsolete path

Addresses: ConsumerDataStandardsAustralia/standards-staging#334

* Business Consumer Provisions

Addresses: #333

* Added link to change description

* Added link to change description

* Standards Maintenance Issue #587: Fixed typos. Re-arranged order of api versions for consistency

* Add style to override class for CX submenu items

* Added Data Holder Dashboards section

Addresses: #334

* Added link to issue

* Added issue link to description

* Added issue link to description

* Updated with data attribute to apply CSS

* Updated with data attribute

* Added FDO details

* Standards Maintenance Issue #613: Changed type of time fields in energy plan data to ExternalRef referring to ISO 8601 Times specification

* Standards Maintenance Issue #613: Changed description of affected time fields for clarity.

* Standards Maintenance Issue #587: Fixed typos

* Standards Maintenance Issue #587: Fixed typo in FDO table

* Retaining majority of useful original anchors

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Display the x-cds-type for array items

Addresses: ConsumerDataStandardsAustralia/standards-staging#348

* Show format of request parameter enums correctly

Addresses: ConsumerDataStandardsAustralia/standards-staging#349

* Adding release notes and delta comments

Update for: ConsumerDataStandardsAustralia/standards-staging#348

* Update to release notes and NBL version delta

* Remove last diffs

* Moving NBL Draft to Candidate Standards

Addresses: #318

* Rebuild

* Add FDO diff statement for 587

* Add diff statements and release notes

* Add diff and release notes

* Add release note reference to CR620

* Add release notes

* Add santa hat

* Update release date

* Fix release notes
Update obligation date counts

* Corrected typo

* Add MI 17 DP to release notes

Addresses: #328

* Updated links

* Updated dates

* Added deprecation dates

* Corrected typo

* Rebuild

* Update change log with DP328

* Standards Staging Issue #359: Known Issues table updated noting incorrect version of Energy Billing APIs

* Updated to known issues

---------

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: kirkycdr <[email protected]>
Co-authored-by: Nils Berge <[email protected]>
HemangCDR added a commit that referenced this issue May 28, 2024
* 1.30.0 branch

* Updates to base build

* Update releasenotes.1.30.0.html.md

* Updated release notes templates

* Corrected typo in Description

Addresses: #361

* Updated links

Addresses: #362

* Updated Principles text for CX

Addresses: #370

* Improved wrapping for long lines

Addresses: #371

* Adding version delta and release notes

* Updates to 'Revoking consent' Standards

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#631

* Removed two outdated statements

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#632

* Corrected typo in `cdr_arragement_id`

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Changed 'Software Package' to 'Software Product'

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Updated documentation to include link

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Clarified documentation

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Updated Non-normative Example

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Clarified Register endpoint responses

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Applied change to Register API in NBL Candidate

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)

* Template code change

Change log and version delta details TBC.
Addresses: #376

* Removed unused Format column

* Updated template and schema mapping

Addresses: #376

* Removed outdated statements and examples

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#543

* Fixed typo

Addresses: #388

* Updated date format

Addresses: #310

* Updated based on feedback in MI18

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#543 (comment)

* Standards Maintenance Issue #624: Converted solarFeedInTariff.timeVaryingTariffs into an array. Added new mandatory displayName field to solarFeedInTariff.timeVaryingTariffs

* Standards Maintenance Issue #625: Added optional period field to various energy rate objects to help support stepped tariff calculation

* Standards Maintenance Issue #627: Made changes to EnergyPlanTariffPeriod to allow sharing of banded daily supply charges

* Standards Maintenance Issue #627: Corrected bandedDailySupplyCharges to an array. Fixed typos in FDO table

* Standards Maintenance Issue #627: Fixed typos in field descriptions

* Standards Maintenance Issue #625: Fixed typos in FDO table

* Standards Maintenance Issue #624: Fixed typos in FDO table

* Standards Maintenance Issue #624: Added new ENUM values CURRENT and VARIABLE to solarFeedInTariff.scheme

* Standards Maintenance Issue #625: Corrected diff and release notes including as part of the change

* Remove spaces causing extra lines when wrapping

* Moving the typo correction to a separate issue

* Final updates to 1.30.0

---------

Co-authored-by: Nils Berge <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: Mark Verstege <[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