ConsumerDataStandardsAustralia / standards-staging

Other
1 stars 0 forks source link

Improve clarity of the PerformanceMetricsV3 structure #396

Closed nils-work closed 3 months ago

nils-work commented 4 months ago

Description In the PerformanceMetricsV3 schema, where the previousDays fields are defined with a type as [array], the values are expected to be an array of days, and each day item as an array of hourly performance values. This format is apparent in the Non-normative Example, but not as clearly communicated by the Properties table showing the type and associated description of the top level field only.

The rendering of the specification doesn't include the detail of what is inside the array (inside the array), even though it is present in the specification file.

Related Work Items Restructure the schema to provide a linked reference to the array structure, to provide more detail in the Properties tables.