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-1.0.0.json"
  • "./error_code_report-1.0.0.json"
  • "https://schemas.exasol.com/error_code_report-0.2.0.json"
  • "./error_code_report-0.2.0.json"

root projectName
Type: string

Typically the GitHub repository name. Default: git-repository name.

root projectVersion
Type: string

root errorCodes
Type: array

List of error-codes of this project.

 No Additional Items

Each item of this array must be:

root errorCodes errorCodeDetails
Type: object
No Additional Properties

root errorCodes errorCodes items identifier
Type: string

Error identifier. E.g: E-Test-1.

root errorCodes errorCodes items 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 errorCodes items messagePlaceholders
Type: array

List of placeholders that are used in the message.

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

 No Additional Items

Each item of this array must be:

root errorCodes errorCodes items messagePlaceholders placeholder
Type: object

Details for each placeholder

 No Additional Properties

root errorCodes errorCodes items messagePlaceholders messagePlaceholders items placeholder
Type: string

Placeholder name without {{ and }}.

root errorCodes errorCodes items messagePlaceholders messagePlaceholders items description
Type: string

Description of the placeholder for the catalog

root errorCodes errorCodes items description
Type: string

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

root errorCodes errorCodes items internalDescription
Type: string

Additional description for developers.

root errorCodes errorCodes items potentialCauses
Type: array of string

Description of known potential causes.

 No Additional Items

Each item of this array must be:

root errorCodes errorCodes items potentialCauses potentialCauses items
Type: string

Description of known potential cause.

root errorCodes errorCodes items mitigations
Type: array of string

Description of known mitigations.

 No Additional Items

Each item of this array must be:

root errorCodes errorCodes items mitigations mitigations items
Type: string

root errorCodes errorCodes items sourceFile
Type: string

Source code file where that the exception is thrown.

root errorCodes errorCodes items sourceLine
Type: number

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

root errorCodes errorCodes items 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.