Exception Code Schema
:::note Auto-generated
This page is generated from exception_code_schema.json by the schema doc generator. To update this page, edit the schema file and run bin/chore gen schema-docs.
:::
Properties
| Property | Type | Required | Description |
|---|---|---|---|
$schema | any | ✓ | |
kind | any | ✓ | |
name | string | ✓ | Name of the exception, as a legal IDL variable name |
display_name | string | ✓ | Pretty display version of the name |
num | integer | ✓ | Exception number, as reported in the *cause CSRs |
definedBy | A condition (YAML structure or IDL function). See the conditions reference for details. | ✓ |
:::note Tooling field
$source is an optional field set automatically by UDB tooling to record the file path this object was loaded from. You do not need to set it manually.
:::
Schema Information
| Property | Value |
|---|---|
| Version | v0.1 |
| JSON Schema Version | Draft 07 |