Proc Cert Model Schema

v0.1

:::note Auto-generated This page is generated from proc_cert_model_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	✓	The short name of the model, used as a database key
long_name	string	✓	One line description of certificate model
base	32 | 64	✓	Base of the model
recommendations	Array<{text}> ↓ schema
extra_notes	Array<{presence, text}> ↓ schema
requirement_groups	object
param_constraints	object
extensions	object
in_scope_priv_modes	Array<M | S | U | HS | VS | VU>		List of in-scope privilege modes for the certificate
debug_manual_revision	string
priv_isa_manual_revision	string
unpriv_isa_manual_revision	string
tsc_profile_release	One of: null | object		Profile release associated with this certificate
introduction	string		Asciidoc text containing the introduction prose for the model
revision_history	Array<{revision, date, changes}> ↓ schema		Revisions of the model document
versions	Array<{version}> ↓ schema		List of semantic versions within the model
class	object		Reference to the class this model belongs to
$parent_of	One of: string | Array<string>
$child_of	One of: string | Array<string>
$inherits	One of: string | Array<string>

recommendations item schema

Property	Type	Required	Description
text	string

extra_notes item schema

Property	Type	Required	Description
presence	mandatory | optional | prohibited | object
text	string

revision_history item schema

Property	Type	Required	Description
revision	string	✓	Revision number
date	string	✓	The date of the change
changes	Array<string>	✓	List of changes

versions item schema

Property	Type	Required	Description
version	string	✓

:::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