Profile Family Schema
:::note Auto-generated
This page is generated from profile_family_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 (database key) of this Profile Family |
long_name | string | ✓ | One line description of family |
processor_kind | Generic Unprivileged | Microcontroller | Apps Processor | What kind of processor is this? | |
marketing_name | string | The publicly displayed profile family name | |
introduction | string | Asciidoc text containing the introduction prose for the family | |
description | string | Array<conditional_text> | Asciidoc text containing longer description prose for the family | |
naming_scheme | string | Commentary on how profile releases in the family are named | |
company | A company | ||
doc_license | License that applies to the textual documentation for this extension |
:::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 |