playbook.v1alpha1.Playbook

Title: playbook.v1alpha1.Playbook

Type	object
Additional properties

Description: Schema for regis Playbook resources (Kubernetes-style envelope).

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ apiVersion	No	const	No	-	API group and version. Must equal 'regis.io/v1alpha1'.
+ kind	No	const	No	-	Resource kind. Must equal 'Playbook'.
+ metadata	No	object	No	-	-
+ spec	No	object	No	-	Playbook body: rules, tiers, badges, presentation, links.

1. Property apiVersion

Type	const

Description: API group and version. Must equal 'regis.io/v1alpha1'.

Specific value: "regis.io/v1alpha1"

2. Property kind

Type	const

Description: Resource kind. Must equal 'Playbook'.

Specific value: "Playbook"

3. Property metadata

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ name	No	string	No	-	Machine identifier (RFC 1123 DNS label): lowercase alphanumerics and '-'.
- title	No	string	No	-	Human-readable display name.
- description	No	string	No	-	Human-readable description of what this playbook evaluates.
+ labels	No	object	No	-	-
- annotations	No	object	No	-	Free-form non-identifying metadata.

3.1. Property name

Type	string

Description: Machine identifier (RFC 1123 DNS label): lowercase alphanumerics and '-'.

Restrictions
Max length	63
Must match regular expression	^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ Test

3.2. Property title

Type	string

Description: Human-readable display name.

3.3. Property description

Type	string

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

3.4. Property labels

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ app.kubernetes.io/version	No	string	No	-	SemVer of the playbook bundle (e.g. "1.2.3").
-	No	string	No	-	-

3.4.1. Property app.kubernetes.io/version

Type	string

Description: SemVer of the playbook bundle (e.g. "1.2.3").

Restrictions
Must match regular expression	^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$ Test

3.4.2. Property additionalProperties

Type	string

3.5. Property annotations

Type	object
Additional properties

Description: Free-form non-identifying metadata.

Property	Pattern	Type	Deprecated	Definition	Title/Description
-	No	string	No	-	-

3.5.1. Property additionalProperties

Type	string

4. Property spec

Type	object
Additional properties

Description: Playbook body: rules, tiers, badges, presentation, links.

Property	Pattern	Type	Deprecated	Definition	Title/Description
- links	No	array of object	No	-	Optional custom links to display as actions for this playbook.
- presentation	No	object	No	-	Platform-neutral presentation directives surfaced to downstream integrations (labels, checklists, templates).
- 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.

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

4.1.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.1. Property label

Type	string

Description: Display label for the link.

4.1.1.2. Property url

Type	string

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

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

4.2. Property presentation

Type	object
Additional properties

Description: Platform-neutral presentation directives surfaced to downstream integrations (labels, checklists, templates).

Property	Pattern	Type	Deprecated	Definition	Title/Description
- badges	No	array of string	No	-	Badge slugs to surface as labels for consuming integrations.
- checklists	No	array of object	No	-	Conditional checklists surfaced by integrations (e.g. in an MR/PR description).
- templates	No	array of object	No	-	Conditional Cookiecutter templates surfaced to integrations.

4.2.1. Property badges

Type	array of string

Description: Badge slugs to surface as labels for consuming integrations.

	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	-

4.2.1.1. badges items

Type	string

4.2.2. Property checklists

Type	array of object

Description: Conditional checklists surfaced by integrations (e.g. in an MR/PR 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	-

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

4.2.2.1.1. Property title

Type	string

Description: Display title for the checklist.

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

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

4.2.2.1.2.1.1. Property label

Type	string

Description: Text of the checkbox item.

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

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

4.2.3. Property templates

Type	array of object

Description: Conditional Cookiecutter templates surfaced to integrations.

	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	-

4.2.3.1. templates items

Type	combining
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
- url	No	string	No	-	Cookiecutter template URL or local path (a git URL is cloned).
- package	No	string	No	-	Installed Python package shipping the template (e.g. 'regis'); resolved to a local path with 'directory', so no clone is performed.
- directory	No	string	No	-	Subdirectory containing the template (relative to the repo for 'url', or to the package root for 'package').
- condition	No	object, array, string, number, boolean or null	No	Same as condition	jsonlogic

Any of(Option)
item 0
item 1

4.2.3.1.1. Property item 0

Type	object
Additional properties

4.2.3.1.1.1. The following properties are required

• url

4.2.3.1.2. Property item 1

Type	object
Additional properties

4.2.3.1.2.1. The following properties are required

• package

4.2.3.1.3. Property url

Type	string

Description: Cookiecutter template URL or local path (a git URL is cloned).

4.2.3.1.4. Property package

Type	string

Description: Installed Python package shipping the template (e.g. 'regis'); resolved to a local path with 'directory', so no clone is performed.

4.2.3.1.5. Property directory

Type	string

Description: Subdirectory containing the template (relative to the repo for 'url', or to the package root for 'package').

4.2.3.1.6. Property condition

Title: jsonlogic

Type	object, array, string, number, boolean or null
Same definition as	condition

Description: JSON Logic expression to conditionally surface the template.

4.3. Property rules

Type	array of object

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

Each item of this array must be	Description
rules items	-

4.3.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. 'cve').
- criterion	No	string	No	-	Criterion template name within the provider (e.g. 'cve-max').
- rule	No	string	No	-	(Deprecated) Alias of 'criterion'. 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	-	-

4.3.1.1. Property slug

Type	string

Description: Unique identifier for the rule instance.

4.3.1.2. Property provider

Type	string

Description: Analyzer name (e.g. 'cve').

4.3.1.3. Property criterion

Type	string

Description: Criterion template name within the provider (e.g. 'cve-max').

4.3.1.4. Property rule

Type	string

Description: (Deprecated) Alias of 'criterion'. Template name within the provider (e.g. 'cve-max').

4.3.1.5. Property options

Type	object
Additional properties

Description: Configuration parameters for the rule template.

Property	Pattern	Type	Deprecated	Definition	Title/Description
-	No	object	No	-	-

4.3.1.6. Property enable

Type	boolean
Default	true

Description: Whether to enable this rule.

4.3.1.7. Property level

Type	enum (of string)

Description: Severity level of the rule.

Must be one of:

• "info"
• "warning"
• "critical"
• "none"

4.3.1.8. Property tags

Type	array of string

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	-

4.3.1.8.1. tags items

Type	string

4.3.1.9. Property messages

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
- pass	No	string	No	-	-
- fail	No	string	No	-	-

4.3.1.9.1. Property pass

Type	string

4.3.1.9.2. Property fail

Type	string

4.4. Property tiers

Type	array of object

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

Each item of this array must be	Description
tiers items	-

4.4.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).
- icon	No	string	No	-	Optional display icon (emoji) for the tier.
+ condition	No	object, array, string, number, boolean or null	No	Same as condition	jsonlogic

4.4.1.1. Property name

Type	string

Description: Tier name (e.g. Gold, Silver, Bronze).

4.4.1.2. Property icon

Type	string

Description: Optional display icon (emoji) for the tier.

4.4.1.3. Property condition

Title: jsonlogic

Type	object, array, string, number, boolean or null
Same definition as	condition

Description: JsonLogic expression evaluated against the report context.

4.5. Property badges

Type	array of object

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

Each item of this array must be	Description
badges items	-

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

4.5.1.1. Property slug

Type	string

Description: Unique identifier for the badge.

4.5.1.2. Property scope

Type	string

Description: Category label displayed on the left part of the badge (e.g. CVE, Freshness).

4.5.1.3. Property value

Type	string

Description: Value displayed on the right part of the badge.

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

4.5.1.5. Property class

Type	enum (of string)

Description: Visual style class for the badge.

Must be one of:

• "success"
• "warning"
• "error"
• "information"

---

Generated using json-schema-for-humans on 2026-06-09 at 12:22:16 +0000