playbook.definition

Title: playbook.definition

Type	combining
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	-	List of playbook pages. Each page groups sections.
- sections	No	array	No	-	List of playbook sections. Each section groups scorecards, levels, and display preferences.
- sidebar	No	object	No	-	Optional sidebar navigation configuration.
- integrations	No	object	No	-	Optional third-party platform integrations (e.g. GitLab, GitHub).

Any of(Option)
item 0
item 1

1. Property item 0

Type	object
Additional properties

1.1. The following properties are required

• sections

2. Property item 1

Type	object
Additional properties

2.1. The following properties are required

• pages

3. Property name

Type	string

Description: Display name of the playbook.

4. Property description

Type	string

Description: Human-readable description of what this playbook evaluates.

5. Property slug

Type	string

Description: Short identifier used for HTML report filename generation.

6. Property links

Type	array of object

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

Each item of this array must be	Description
links items	-

6.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	No	In jsonlogic.schema.json	Optional JsonLogic expression to determine if the link should be displayed.

6.1.1. Property label

Type	string

Description: Display label for the link.

6.1.2. Property url

Type	string

Description: URL template which can use {metadata[key]} placeholders or Jinja2 syntax.

6.1.3. Property condition

Type	object
Additional properties
Defined in	jsonlogic.schema.json

Description: Optional JsonLogic expression to determine if the link should be displayed.

7. Property pages

Type	array

Description: List of playbook pages. Each page groups 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
page	A playbook page containing sections.

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

7.1.1. Property title

Type	string

Description: Display name of the page.

7.1.2. Property slug

Type	string

Description: Short identifier used for HTML report filename generation. If not provided, it falls back to the playbook slug.

7.1.3. Property sections

Type	array

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.

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

7.1.3.1.1. Property name

Type	string

Description: Display name of the section.

7.1.3.1.2. Property hint

Type	string

Description: Optional informative text displayed below the section name.

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

7.1.3.1.3.1. Property analyzers

Type	array of string

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

Each item of this array must be	Description
analyzers items	-

7.1.3.1.3.1.1. analyzers items

Type	string

7.1.3.1.3.2. Property widgets

Type	array

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.

7.1.3.1.3.2.1. 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.

7.1.3.1.3.2.1.1. Property label

Type	string

Description: Display label for the widget.

7.1.3.1.3.2.1.2. Property value

Type	string

Description: Dot-separated path into the report data, e.g. 'results.trivy.critical_count'.

7.1.3.1.3.2.1.3. Property url

Type	string

Description: Optional URL for the widget. Supports Jinja2 templates.

7.1.3.1.3.2.1.4. Property icon

Type	string

Description: Emoji or icon displayed alongside the widget.

7.1.3.1.3.2.1.5. Property template

Type	string

Description: Path to a Jinja2 HTML template within the theme, e.g. analyzers/trivy/table.html.

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

7.1.3.1.3.2.1.6.1. Property title

Type	string

Description: Optional title for the widget. If provided, the widget will be displayed with a header.

7.1.3.1.3.2.1.6.2. Property collapsed

Type	boolean
Default	false

Description: If true, the widget will be collapsible and closed by default.

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

• "left"
• "center"
• "right"

7.1.3.1.3.2.1.6.4. Property subvalue

Type	string

Description: Additional text/value to display below the main value. Follows identical resolution logic as value.

7.1.3.1.3.2.1.6.5. Property class

Type	string
Default	""

Description: Additional CSS class(es) to apply to the widget container.

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

7.1.3.1.4. Property levels

Type	array

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.

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

7.1.3.1.4.1.1. Property name

Type	string

Description: Level identifier referenced by scorecards.

7.1.3.1.4.1.2. Property label

Type	string

Description: Human-readable display label.

7.1.3.1.4.1.3. Property order

Type	integer

Description: Sort order (lower value = higher priority). Built-in defaults: bronze=1, silver=2, gold=3.

7.1.3.1.5. Property scorecards

Type	array

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.

7.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.
- title	No	string	No	-	Human-readable title. 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.

7.1.3.1.5.1.1. Property name

Type	string

Description: Unique identifier for the scorecard.

7.1.3.1.5.1.2. Property title

Type	string

Description: Human-readable title. Defaults to name if omitted.

7.1.3.1.5.1.3. Property level

Type	string

Description: Level this scorecard belongs to. Must match a level name defined in the section.

7.1.3.1.5.1.4. Property tags

Type	array of string

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	-

7.1.3.1.5.1.4.1. tags items

Type	string

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

7.1.3.1.6. Property widgets

Type	array

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.

7.1.3.1.6.1. widget

Type	object
Additional properties
Same definition as	pages_items_sections_items_display_widgets_items

Description: A key-value widget displaying a metric from the analysis report, or a custom HTML template widget.

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

8. Property sections

Type	array

Description: List of playbook sections. Each section groups scorecards, levels, and display preferences.

	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.

8.1. section

Type	object
Additional properties
Same definition as	pages_items_sections_items

Description: A playbook section containing scorecards, optional levels, and display preferences.

9. Property sidebar

Type	object
Additional properties

Description: Optional sidebar navigation configuration.

Property	Pattern	Type	Deprecated	Definition	Title/Description
- sections	No	array of object	No	-	-
- links	No	array of object	No	-	-

9.1. Property sections

Type	array of object

	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
sections items	-

9.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.

9.1.1.1. Property title

Type	string

Description: Title of the sidebar section.

9.1.1.2. Property links

Type	array of object

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

Each item of this array must be	Description
links items	-

9.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.

9.1.1.2.1.1. Property label

Type	string

Description: Display label.

9.1.1.2.1.2. Property url

Type	string

Description: Target URL.

9.1.1.2.1.3. Property icon

Type	string

Description: Icon name or emoji.

9.2. Property links

Type	array of object

	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
links items	-

9.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.

9.2.1.1. Property label

Type	string

Description: Display label.

9.2.1.2. Property url

Type	string

Description: Target URL.

9.2.1.3. Property icon

Type	string

Description: Icon name or emoji.

10. 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	-	-

10.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.

10.1.1. Property badges

Type	array of string

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

Each item of this array must be	Description
badges items	-

10.1.1.1. badges items

Type	string

10.1.2. Property checklist

Type	array

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

Each item of this array must be	Description
checklist_item	-

10.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 (- [ ]).

10.1.2.1.1. Property label

Type	string

Description: Text of the checkbox item.

10.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.

10.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 (- [ ]).

10.1.3. Property checklists

Type	array of object

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

Each item of this array must be	Description
checklists items	-

10.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.

10.1.3.1.1. Property title

Type	string

Description: Display title for the checklist.

10.1.3.1.2. Property items

Type	array

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

Each item of this array must be	Description
checklist_item	-

10.1.3.1.2.1. checklist_item

Type	object
Additional properties
Same definition as	integrations_gitlab_checklist_items

10.1.4. Property templates

Type	array of object

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

Each item of this array must be	Description
templates items	-

10.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	No	In jsonlogic.schema.json	JSON Logic expression to conditionally render the template.

10.1.4.1.1. Property url

Type	string

Description: Cookiecutter template URL or path.

10.1.4.1.2. Property directory

Type	string

Description: Optional subdirectory within the repository containing the template.

10.1.4.1.3. Property condition

Type	object
Additional properties
Defined in	jsonlogic.schema.json

Description: JSON Logic expression to conditionally render the template.

---

Generated using json-schema-for-humans on 2026-03-20 at 04:11:57 +0100