Exasol error code report schema.

Type: object

This schema defines the structure of a report about error codes in an Exasol project.

 No Additional Properties

root $schema
Type: enum (of string)

Reference to the schema. Setting this helps your IDE to assist you while writing the definition.

Must be one of:

  • "https://schemas.exasol.com/error_code_report-0.1.0.json"
  • "./error_code_report-0.1.0.json"

root projectName
Type: string

Typically the GitHub repository name.

root projectVersion
Type: string

root errorCodes
Type: object

Object that maps the error code to an errorCodeDetails object describing the error code.

The error code must match ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$
root errorCodes errorCodeDetails
Type: object
No Additional Properties

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ message
Type: string

Error message (the message of the exception) without error code. The exception message can contain placeholders like {{NAME}}. In that case you must define the placeholder in messagePlaceholders.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ messagePlaceholders
Type: object

Map (placeholder -> description) of placeholders that are used in the message.

Use the placeholder without {{ and }} as key and the description as value.

Each additional property must conform to the following schema

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ messagePlaceholders additionalProperties
Type: string

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ description
Type: string

Additional information about what this error code means or more context about what its purpose is.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ internalDescription
Type: string

Additional description for developers.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ potentialCauses
Type: array of string

Description of known potential causes.

 No Additional Items

Each item of this array must be:

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ potentialCauses potentialCauses items
Type: string

Description of known potential cause.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ mitigations
Type: array of string

Description of known mitigations.

 No Additional Items

Each item of this array must be:

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ mitigations mitigations items
Type: string

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ sourceFile
Type: string

Source code file where that the exception is thrown.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ sourceLine
Type: number

Source code line number within the the source file where the exception is thrown.

root errorCodes ^[WFE]-[A-Z][A-Z0-9]*(-[A-Z][A-Z0-9]*)*-\d+$ contextHash
Type: string

HashCode of the source code context around where the exception is thrown.

It can be used for detecting possible changes among versions.