Param Schema
:::note Auto-generated
This page is generated from param_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 | ✓ | |
long_name | string | ✓ | Short description of the parameter |
description | string | Array<conditional_text> | ✓ | Parameter description, including list of valid values |
definedBy | A condition (YAML structure or IDL function). See the conditions reference for details. | ✓ | Extension requirement condition that must be met for parameter to exist. The condition that the defining extension is implemented is implicit, and does not need to be explicitly listed |
schema | json-schema-draft-07 | ✓ | |
name | string (pattern: ^[A-Z][A-Z_0-9]*$) | ||
requirements | 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 |