Title: playbook.definition
| |
|---|
| Type | object |
| Additional properties |  |
Description: Schema for regis-cli playbook definition files (YAML or JSON).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + name | No | string | No | - | Display name of the playbook. |
| - description | No | string | No | - | Human-readable description of what this playbook evaluates. |
| - slug | No | string | No | - | Short identifier used for HTML report filename generation. |
| - links | No | array of object | No | - | Optional custom links to display as actions for this playbook. |
| - pages | No | array | No | - | Deprecated: List of playbook pages for the legacy Jinja2 HTML renderer. Not used by the Docusaurus report viewer. Use `rules` instead. |
| - sections | No | array | No | - | Deprecated: List of playbook sections for the legacy renderer. Not used by the Docusaurus report viewer. Use `rules` instead. |
| - sidebar | No | object | No | - | Deprecated: Sidebar navigation for the legacy Jinja2 renderer. |
| - integrations | No | object | No | - | Optional third-party platform integrations (e.g. GitLab, GitHub). |
| - rules | No | array of object | No | - | Custom rule overrides or template instantiations. |
| - tiers | No | array of object | No | - | Compliance tier thresholds. Each tier is awarded when its JsonLogic condition evaluates to true, evaluated in order. |
| - badges | No | array of object | No | - | Dynamic status badges displayed in the report header. Each badge is conditionally rendered based on a JsonLogic expression. |
1.
Property name
Description: Display name of the playbook.
2.
Property description
Description: Human-readable description of what this playbook evaluates.
3.
Property slug
Description: Short identifier used for HTML report filename generation.
4.
Property links
Description: Optional custom links to display as actions for this playbook.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
4.1. links items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + label | No | string | No | - | Display label for the link. |
| + url | No | string | No | - | URL template which can use {metadata[key]} placeholders or Jinja2 syntax. |
| - condition | No | object, array, string, number, boolean or null | No | In jsonlogic.schema.json | jsonlogic |
4.1.1. Property label
Description: Display label for the link.
4.1.2. Property url
Description: URL template which can use {metadata[key]} placeholders or Jinja2 syntax.
4.1.3. Property condition
Title: jsonlogic
| |
|---|
| Type | object, array, string, number, boolean or null |
| Defined in | jsonlogic.schema.json |
Description: Optional JsonLogic expression to determine if the link should be displayed.
5.
Property pages
Description: Deprecated: List of playbook pages for the legacy Jinja2 HTML renderer. Not used by the Docusaurus report viewer. Use rules instead.
| Array restrictions |
|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| page | A playbook page containing sections. |
5.1. page
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/page |
Description: A playbook page containing sections.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + title | No | string | No | - | Display name of the page. |
| - slug | No | string | No | - | Short identifier used for HTML report filename generation. If not provided, it falls back to the playbook slug. |
| + sections | No | array | No | - | List of playbook sections. |
5.1.1. Property title
Description: Display name of the page.
5.1.2. Property slug
Description: Short identifier used for HTML report filename generation. If not provided, it falls back to the playbook slug.
5.1.3. Property sections
Description: List of playbook sections.
| Array restrictions |
|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| section | A playbook section containing scorecards, optional levels, and display preferences. |
5.1.3.1. section
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/section |
Description: A playbook section containing scorecards, optional levels, and display preferences.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - name | No | string | No | - | Display name of the section. |
| - hint | No | string | No | - | Optional informative text displayed below the section name. |
| - display | No | object | No | In #/$defs/display | Rendering preferences for the section. |
| - levels | No | array | No | - | Priority/severity levels used to group scorecards. Built-in fallback order exists for bronze, silver, gold. |
| - scorecards | No | array | No | - | Evaluation scorecards with JsonLogic conditions. |
| - widgets | No | array | No | - | KPI and Template widgets displayed in the section. |
| - condition | No | object | No | - | Optional jsonLogic expression to conditionally display this section. If it evaluates to falsy, the section is hidden. |
5.1.3.1.1. Property name
Description: Display name of the section.
5.1.3.1.2. Property hint
Description: Optional informative text displayed below the section name.
5.1.3.1.3. Property display
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/display |
Description: Rendering preferences for the section.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - analyzers | No | array of string | No | - | List of analyzer names whose output should be embedded in this section. |
| - widgets | No | array | No | - | KPI widgets displayed in the section header. |
5.1.3.1.3.1. Property analyzers
Description: List of analyzer names whose output should be embedded in this section.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
5.1.3.1.3.1.1. analyzers items
Description: KPI widgets displayed in the section header.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| widget | A key-value widget displaying a metric from the analysis report, or a custom HTML template widget. |
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/widget |
Description: A key-value widget displaying a metric from the analysis report, or a custom HTML template widget.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - label | No | string | No | - | Display label for the widget. |
| - value | No | string | No | - | Dot-separated path into the report data, e.g. 'results.trivy.critical_count'. |
| - url | No | string | No | - | Optional URL for the widget. Supports Jinja2 templates. |
| - icon | No | string | No | - | Emoji or icon displayed alongside the widget. |
| - template | No | string | No | - | Path to a Jinja2 HTML template within the theme, e.g. analyzers/trivy/table.html. |
| - options | No | object | No | - | Arbitrary options passed directly to the Jinja2 template. |
| - condition | No | object | No | - | Optional jsonLogic expression to conditionally display this widget. If it evaluates to falsy, the widget is hidden. |
5.1.3.1.3.2.1.1. Property label
Description: Display label for the widget.
5.1.3.1.3.2.1.2. Property value
Description: Dot-separated path into the report data, e.g. 'results.trivy.critical_count'.
5.1.3.1.3.2.1.3. Property url
Description: Optional URL for the widget. Supports Jinja2 templates.
5.1.3.1.3.2.1.4. Property icon
Description: Emoji or icon displayed alongside the widget.
5.1.3.1.3.2.1.5. Property template
Description: Path to a Jinja2 HTML template within the theme, e.g. analyzers/trivy/table.html.
5.1.3.1.3.2.1.6. Property options
| |
|---|
| Type | object |
| Additional properties |  |
Description: Arbitrary options passed directly to the Jinja2 template.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - title | No | string | No | - | Optional title for the widget. If provided, the widget will be displayed with a header. |
| - collapsed | No | boolean | No | - | If true, the widget will be collapsible and closed by default. |
| - align | No | enum (of string) | No | - | Text alignment for the widget (left, center, or right) |
| - subvalue | No | string | No | - | Additional text/value to display below the main value. Follows identical resolution logic as value. |
| - class | No | string | No | - | Additional CSS class(es) to apply to the widget container. |
5.1.3.1.3.2.1.6.1. Property title
Description: Optional title for the widget. If provided, the widget will be displayed with a header.
5.1.3.1.3.2.1.6.2. Property collapsed
Description: If true, the widget will be collapsible and closed by default.
5.1.3.1.3.2.1.6.3. Property align
| |
|---|
| Type | enum (of string) |
| Default | "left" |
Description: Text alignment for the widget (left, center, or right)
Must be one of:
5.1.3.1.3.2.1.6.4. Property subvalue
Description: Additional text/value to display below the main value. Follows identical resolution logic as value.
5.1.3.1.3.2.1.6.5. Property class
Description: Additional CSS class(es) to apply to the widget container.
5.1.3.1.3.2.1.7. Property condition
| |
|---|
| Type | object |
| Additional properties |  |
Description: Optional jsonLogic expression to conditionally display this widget. If it evaluates to falsy, the widget is hidden.
5.1.3.1.4. Property levels
Description: Priority/severity levels used to group scorecards. Built-in fallback order exists for bronze, silver, gold.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| level | A priority/severity level used to group and summarise scorecards. |
5.1.3.1.4.1. level
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/level |
Description: A priority/severity level used to group and summarise scorecards.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + name | No | string | No | - | Level identifier referenced by scorecards. |
| - label | No | string | No | - | Human-readable display label. |
| - order | No | integer | No | - | Sort order (lower value = higher priority). Built-in defaults: bronze=1, silver=2, gold=3. |
5.1.3.1.4.1.1. Property name
Description: Level identifier referenced by scorecards.
5.1.3.1.4.1.2. Property label
Description: Human-readable display label.
5.1.3.1.4.1.3. Property order
Description: Sort order (lower value = higher priority). Built-in defaults: bronze=1, silver=2, gold=3.
5.1.3.1.5. Property scorecards
Description: Evaluation scorecards with JsonLogic conditions.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| scorecard | An evaluation scorecard with a JsonLogic condition. |
5.1.3.1.5.1. scorecard
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/scorecard |
Description: An evaluation scorecard with a JsonLogic condition.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + name | No | string | No | - | Unique identifier for the scorecard. |
| - description | No | string | No | - | Human-readable description. Defaults to name if omitted. |
| - level | No | string | No | - | Level this scorecard belongs to. Must match a level name defined in the section. |
| - tags | No | array of string | No | - | Arbitrary tags for filtering or grouping. |
| + condition | No | object | No | - | JsonLogic expression evaluated against the flattened analysis report. Variables use dot-paths, e.g. {"var": "results.trivy.critical_count"}. Supported operators: ==, !=, >, >=, <, <=, in, !, and, or. |
5.1.3.1.5.1.1. Property name
Description: Unique identifier for the scorecard.
5.1.3.1.5.1.2. Property description
Description: Human-readable description. Defaults to name if omitted.
5.1.3.1.5.1.3. Property level
Description: Level this scorecard belongs to. Must match a level name defined in the section.
Description: Arbitrary tags for filtering or grouping.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| tags items | - |
5.1.3.1.5.1.5. Property condition
| |
|---|
| Type | object |
| Additional properties |  |
Description: JsonLogic expression evaluated against the flattened analysis report. Variables use dot-paths, e.g. {"var": "results.trivy.critical_count"}. Supported operators: ==, !=, >, >=, <, <=, in, !, and, or.
Description: KPI and Template widgets displayed in the section.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| widget | A key-value widget displaying a metric from the analysis report, or a custom HTML template widget. |
Description: A key-value widget displaying a metric from the analysis report, or a custom HTML template widget.
5.1.3.1.7. Property condition
| |
|---|
| Type | object |
| Additional properties |  |
Description: Optional jsonLogic expression to conditionally display this section. If it evaluates to falsy, the section is hidden.
6.
Property sections
Description: Deprecated: List of playbook sections for the legacy renderer. Not used by the Docusaurus report viewer. Use rules instead.
| Array restrictions |
|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| section | A playbook section containing scorecards, optional levels, and display preferences. |
6.1. section
Description: A playbook section containing scorecards, optional levels, and display preferences.
| |
|---|
| Type | object |
| Additional properties |  |
Description: Deprecated: Sidebar navigation for the legacy Jinja2 renderer.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - sections | No | array of object | No | - | - |
| - links | No | array of object | No | - | - |
7.1.
Property sections
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
7.1.1. sections items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - title | No | string | No | - | Title of the sidebar section. |
| + links | No | array of object | No | - | List of links in this section. |
7.1.1.1. Property title
Description: Title of the sidebar section.
7.1.1.2. Property links
Description: List of links in this section.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
7.1.1.2.1. links items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + label | No | string | No | - | Display label. |
| + url | No | string | No | - | Target URL. |
| - icon | No | string | No | - | Icon name or emoji. |
7.1.1.2.1.1. Property label
Description: Display label.
7.1.1.2.1.2. Property url
Description: Target URL.
7.1.1.2.1.3. Property icon
Description: Icon name or emoji.
7.2.
Property links
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
7.2.1. links items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + label | No | string | No | - | Display label. |
| + url | No | string | No | - | Target URL. |
| - icon | No | string | No | - | Icon name or emoji. |
7.2.1.1. Property label
Description: Display label.
7.2.1.2. Property url
Description: Target URL.
7.2.1.3. Property icon
Description: Icon name or emoji.
8.
Property integrations
| |
|---|
| Type | object |
| Additional properties |  |
Description: Optional third-party platform integrations (e.g. GitLab, GitHub).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - gitlab | No | object | No | - | - |
8.1.
Property gitlab
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - badges | No | array of string | No | - | List of badge slugs to be imported as GitLab Merge Request labels. |
| - checklist | No | array | No | - | (Deprecated) Single checklist items added as checkboxes to the Merge Request description. |
| - checklists | No | array of object | No | - | Configurable checklists added as checkboxes to the Merge Request description. |
| - templates | No | array of object | No | - | URLs to Cookiecutter templates that will be rendered and added to the Merge Request branch. |
8.1.1.
Property badges
Description: List of badge slugs to be imported as GitLab Merge Request labels.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
8.1.1.1. badges items
8.1.2.
Property checklist
Description: (Deprecated) Single checklist items added as checkboxes to the Merge Request description.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
8.1.2.1. checklist_item
| |
|---|
| Type | object |
| Additional properties |  |
| Defined in | #/$defs/checklist_item |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + label | No | string | No | - | Text of the checkbox item. |
| - show_if | No | object | No | - | Optional JsonLogic expression. If provided, the item is only included when the expression evaluates to truthy. |
| - check_if | No | object | No | - | Optional JsonLogic expression. If provided and evaluates to truthy, the checkbox renders pre-checked (- [x]). Otherwise it renders unchecked (- [ ]). |
8.1.2.1.1. Property label
Description: Text of the checkbox item.
8.1.2.1.2. Property show_if
| |
|---|
| Type | object |
| Additional properties |  |
Description: Optional JsonLogic expression. If provided, the item is only included when the expression evaluates to truthy.
8.1.2.1.3. Property check_if
| |
|---|
| Type | object |
| Additional properties |  |
Description: Optional JsonLogic expression. If provided and evaluates to truthy, the checkbox renders pre-checked (- [x]). Otherwise it renders unchecked (- [ ]).
8.1.3.
Property checklists
Description: Configurable checklists added as checkboxes to the Merge Request description.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
8.1.3.1. checklists items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - title | No | string | No | - | Display title for the checklist. |
| + items | No | array | No | - | Items in this checklist. |
8.1.3.1.1. Property title
Description: Display title for the checklist.
8.1.3.1.2. Property items
Description: Items in this checklist.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
8.1.3.1.2.1. checklist_item
8.1.4.
Property templates
Description: URLs to Cookiecutter templates that will be rendered and added to the Merge Request branch.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
8.1.4.1. templates items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + url | No | string | No | - | Cookiecutter template URL or path. |
| - directory | No | string | No | - | Optional subdirectory within the repository containing the template. |
| - condition | No | object, array, string, number, boolean or null | No | Same as condition | jsonlogic |
8.1.4.1.1. Property url
Description: Cookiecutter template URL or path.
8.1.4.1.2. Property directory
Description: Optional subdirectory within the repository containing the template.
8.1.4.1.3. Property condition
Title: jsonlogic
| |
|---|
| Type | object, array, string, number, boolean or null |
| Same definition as | condition |
Description: JSON Logic expression to conditionally render the template.
9.
Property rules
Description: Custom rule overrides or template instantiations.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
9.1. rules items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - slug | No | string | No | - | Unique identifier for the rule instance. |
| - provider | No | string | No | - | Analyzer name (e.g. 'trivy'). |
| - rule | No | string | No | - | Template name within the provider (e.g. 'cve-max'). |
| - options | No | object | No | - | Configuration parameters for the rule template. |
| - enable | No | boolean | No | - | Whether to enable this rule. |
| - level | No | enum (of string) | No | - | Severity level of the rule. |
| - tags | No | array of string | No | - | Arbitrary tags. |
| - messages | No | object | No | - | - |
9.1.1. Property slug
Description: Unique identifier for the rule instance.
9.1.2. Property provider
Description: Analyzer name (e.g. 'trivy').
9.1.3. Property rule
Description: Template name within the provider (e.g. 'cve-max').
9.1.4. Property options
| |
|---|
| Type | object |
| Additional properties |  |
Description: Configuration parameters for the rule template.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - | No | object | No | - | - |
9.1.5. Property enable
Description: Whether to enable this rule.
9.1.6. Property level
Description: Severity level of the rule.
Must be one of:
- "info"
- "warning"
- "critical"
- "none"
Description: Arbitrary tags.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| tags items | - |
9.1.8. Property messages
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - pass | No | string | No | - | - |
| - fail | No | string | No | - | - |
9.1.8.1. Property pass
9.1.8.2. Property fail
10.
Property tiers
Description: Compliance tier thresholds. Each tier is awarded when its JsonLogic condition evaluates to true, evaluated in order.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
10.1. tiers items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + name | No | string | No | - | Tier name (e.g. Gold, Silver, Bronze). |
| + condition | No | object, array, string, number, boolean or null | No | Same as condition | jsonlogic |
10.1.1. Property name
Description: Tier name (e.g. Gold, Silver, Bronze).
10.1.2. Property condition
Title: jsonlogic
| |
|---|
| Type | object, array, string, number, boolean or null |
| Same definition as | condition |
Description: JsonLogic expression evaluated against the report context.
11.
Property badges
Description: Dynamic status badges displayed in the report header. Each badge is conditionally rendered based on a JsonLogic expression.
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
11.1. badges items
| |
|---|
| Type | object |
| Additional properties |  |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + slug | No | string | No | - | Unique identifier for the badge. |
| + scope | No | string | No | - | Category label displayed on the left part of the badge (e.g. CVE, Freshness). |
| + value | No | string | No | - | Value displayed on the right part of the badge. |
| + condition | No | object, array, string, number, boolean or null | No | Same as condition | jsonlogic |
| + class | No | enum (of string) | No | - | Visual style class for the badge. |
11.1.1. Property slug
Description: Unique identifier for the badge.
11.1.2. Property scope
Description: Category label displayed on the left part of the badge (e.g. CVE, Freshness).
11.1.3. Property value
Description: Value displayed on the right part of the badge.
11.1.4. Property condition
Title: jsonlogic
| |
|---|
| Type | object, array, string, number, boolean or null |
| Same definition as | condition |
Description: JsonLogic expression. The badge is shown when this evaluates to truthy.
11.1.5. Property class
Description: Visual style class for the badge.
Must be one of:
- "success"
- "warning"
- "error"
- "information"
Generated using json-schema-for-humans on 2026-03-21 at 11:43:38 +0000