Skip to content

Update the alias reference syntax in confdb-schemas #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
degville merged 1 commit into from
Aug 4, 2025
Merged

Update the alias reference syntax in confdb-schemas #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/reference/assertions/confdb-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ sign-key-sha3-384: 74KHeq1foV...
}
},
"sample-rate": {
"keys": "$sensor-name",
"keys": "${sensor-name}",
"values": {
"choices": [
100,
Expand All @@ -132,7 +132,7 @@ pq2emmvcElyUfJhfCXw391X5UC8rMGeHm4vUKfFDRGCeplyFFmVaiyIZ4d39NQr38wI5r9yLJB1W
```

As can be seen in the example, the schema is expressed as a set of nested JSON objects with types and constraints. All keys are optional such that a partial or empty configuration is considered valid and values can be any JSON value, except `null`.
There are seven predefined types: `map`, `array`, `string`, `int`, `number`, `bool` and `any`. In addition to those types, user-defined types can also be introduced and later referred to with a ``$`` prefix. We'll describe these types and their constraints in detail below.
There are seven predefined types: `map`, `array`, `string`, `int`, `number`, `bool` and `any`. In addition to those types, user-defined types can also be introduced and later referred to by wrapping the name with ``${...}``. We'll describe these types and their constraints in detail below.

Typically, a type will look like:

Expand Down Expand Up @@ -274,7 +274,7 @@ Type definitions can also take the form of a list of alternative types. When val
```

### Aliases
`aliases` is a special field in the top level map where user-defined types can be composed from the predefined types and their constraints. This field must be a map associating new type names to their type definitions. Type definitions can then use these aliases by prefixing them with a `$` character.
`aliases` is a special field in the top level map where user-defined types can be composed from the predefined types and their constraints. This field must be a map associating new type names to their type definitions. Type definitions can then use these aliases by wrapping them with `${...}`.

```
{
Expand All @@ -288,7 +288,7 @@ Type definitions can also take the form of a list of alternative types. When val
},
"schema": {
"name": "string",
"version": "$version_str"
"version": "${version_str}"
}
}
```
Expand Down