Get Metrics V5 error metrics documentation

[nils-work]

Description

To ensure the requirements are clear, the field descriptions in the ErrorMetricsV2 schema could indicate that errors are to be reported against each respective error code in the 4xx and 5xx series where the example additionalProperties and property1 and property2 fields currently appear.

Intention and Value of Change

Ensure compliant Get Metrics responses are provided to allow detailed analysis of ecosystem performance.

Area Affected

Get Metrics endpoint > ErrorMetricsV2 schema

Change Proposed

Make the following changes to the documentation only, to provide clarity of the existing requirement. No changes to the endpoint version or structure are proposed.

Name	Description
»» additionalProperties	~~Number of errors for a specific HTTP error code. Note that the property name must be 3 digits represent the HTTP error code the error is for~~ This is a placeholder field to be substituted with each respective HTTP error code in the 4xx and 5xx range recorded by the Data Holder. It is represented by property1 and property2 in the Non-normative Examples section. Note that the property name MUST be the three-digit HTTP error code as per the adjacent 500 example. All possible property names have not been defined as the range is expected to vary across participants. Examples would include, but are not limited to: 400, 401, 403, 404, 405, 406, 415, 422, 429, 500, 503, 504.
»» 500	~~Number of errors for HTTP error code 500. Note that this field is an example of a single entry due to the lack of OAS support [for the] JSON Schema patternProperties syntax. See the additionalProperties field in this schema for the generic property structure for error code counts~~ Reflecting the description provided in the adjacent additionalProperties field, this is an example demonstrating the structure for reporting the number of calls resulting in HTTP error code 500. Each error code recorded by the Data Holder in the 4xx and 5xx range MUST be provided in this format against the respective property name.