playbook.result

Title: playbook.result

Type	object
Additional properties

Description: Final playbook result produced by regis, containing metadata and analyzer results.

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ playbook_name	No	string	No	-	Identifier of the playbook that was executed.
- playbook_version	No	string or null	No	-	SemVer of the playbook that produced this report.
- api_version	No	string or null	No	-	apiVersion of the playbook that produced this result (e.g. "regis.io/v1alpha1").
- sidebar	No	object	No	-	Sidebar navigation metadata for the report UI.
- version	No	string or null	No	-	Version of regis that generated this report.
- tier	No	string or null	No	-	The earned tier (e.g. Gold, Silver, Bronze) based on playbook conditions.
- badges	No	array of object	No	-	-
- rules	No	array of object	No	-	-
- rules_summary	No	object	No	-	-
+ score	No	integer	No	-	Overall percentage score for the playbook.
+ total_scorecards	No	integer	No	-	Total number of scorecards evaluated.
+ passed_scorecards	No	integer	No	-	Number of scorecards that passed.
- links	No	array of object	No	-	External links associated with this playbook result.
+ pages	No	array of object	No	-	-
- checklists	No	array of object	No	-	Resolved checklists surfaced to downstream integrations.
- templates	No	array of object	No	-	Cookiecutter templates surfaced to downstream integrations.

1. Property playbook_name

Type	string

Description: Identifier of the playbook that was executed.

2. Property playbook_version

Type	string or null

Description: SemVer of the playbook that produced this report.

3. Property api_version

Type	string or null

Description: apiVersion of the playbook that produced this result (e.g. "regis.io/v1alpha1").

4. Property sidebar

Type	object
Additional properties

Description: Sidebar navigation metadata for the report UI.

5. Property version

Type	string or null

Description: Version of regis that generated this report.

6. Property tier

Type	string or null

Description: The earned tier (e.g. Gold, Silver, Bronze) based on playbook conditions.

7. Property badges

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

7.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	-	Domain of the badge (e.g., 'security', 'hygiene').
- value	No	string or null	No	-	Display value or grade (e.g., 'A', '95%').
+ class	No	enum (of string)	No	-	Visual style indicator.
- label	No	string	No	-	The full label string (scope or scope: value).

7.1.1. Property slug

Type	string

Description: Unique identifier for the badge.

7.1.2. Property scope

Type	string

Description: Domain of the badge (e.g., 'security', 'hygiene').

7.1.3. Property value

Type	string or null

Description: Display value or grade (e.g., 'A', '95%').

7.1.4. Property class

Type	enum (of string)

Description: Visual style indicator.

Must be one of:

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

7.1.5. Property label

Type	string

Description: The full label string (scope or scope: value).

8. Property rules

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

8.1. rules items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ slug	No	string	No	-	Unique identifier for the rule.
+ description	No	string	No	-	Human-readable name of the rule.
- level	No	string	No	-	Priority level (Gold, Silver, Bronze).
- tags	No	array of string	No	-	Associated metadata tags.
+ passed	No	boolean	No	-	Whether the rule criteria were met.
+ status	No	enum (of string)	No	-	Detailed execution status.
+ message	No	string	No	-	Reasoning or details for the rule result.
- analyzers	No	array of string	No	-	List of analyzers that contributed data to this rule.

8.1.1. Property slug

Type	string

Description: Unique identifier for the rule.

8.1.2. Property description

Type	string

Description: Human-readable name of the rule.

8.1.3. Property level

Type	string

Description: Priority level (Gold, Silver, Bronze).

8.1.4. Property tags

Type	array of string

Description: Associated metadata 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	-

8.1.4.1. tags items

Type	string

8.1.5. Property passed

Type	boolean

Description: Whether the rule criteria were met.

8.1.6. Property status

Type	enum (of string)

Description: Detailed execution status.

Must be one of:

• "passed"
• "failed"
• "incomplete"

8.1.7. Property message

Type	string

Description: Reasoning or details for the rule result.

8.1.8. Property analyzers

Type	array of string

Description: List of analyzers that contributed data to this rule.

	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	-

8.1.8.1. analyzers items

Type	string

9. Property rules_summary

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ score	No	integer	No	-	-
+ total	No	array of string	No	-	-
+ passed	No	array of string	No	-	-
- by_tag	No	object	No	-	-

9.1. Property score

Type	integer

Restrictions
Minimum	≥ 0
Maximum	≤ 100

9.2. Property total

Type	array of string

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

9.2.1. total items

Type	string

9.3. Property passed

Type	array of string

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

9.3.1. passed items

Type	string

9.4. Property by_tag

Type	object
Additional properties

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

9.4.1. Property additionalProperties

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ rules	No	array of string	No	-	-
+ passed_rules	No	array of string	No	-	-
+ score	No	integer	No	-	-

9.4.1.1. Property rules

Type	array of string

	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	-

9.4.1.1.1. rules items

Type	string

9.4.1.2. Property passed_rules

Type	array of string

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

9.4.1.2.1. passed_rules items

Type	string

9.4.1.3. Property score

Type	integer

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10. Property score

Type	integer

Description: Overall percentage score for the playbook.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

11. Property total_scorecards

Type	integer

Description: Total number of scorecards evaluated.

Restrictions
Minimum	≥ 0

12. Property passed_scorecards

Type	integer

Description: Number of scorecards that passed.

Restrictions
Minimum	≥ 0

13. Property links

Type	array of object

Description: External links associated with this playbook result.

	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	-

13.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	-	Target URL.

13.1.1. Property label

Type	string

Description: Display label for the link.

13.1.2. Property url

Type	string

Description: Target URL.

14. Property pages

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

14.1. pages items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ title	No	string	No	-	Page title.
- slug	No	string or null	No	-	URL-friendly identifier for the page.
+ score	No	integer	No	-	Percentage score for this page.
+ total_scorecards	No	integer	No	-	Total scorecards on this page.
+ passed_scorecards	No	integer	No	-	Passed scorecards on this page.
+ sections	No	array of object	No	-	-

14.1.1. Property title

Type	string

Description: Page title.

14.1.2. Property slug

Type	string or null

Description: URL-friendly identifier for the page.

14.1.3. Property score

Type	integer

Description: Percentage score for this page.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

14.1.4. Property total_scorecards

Type	integer

Description: Total scorecards on this page.

Restrictions
Minimum	≥ 0

14.1.5. Property passed_scorecards

Type	integer

Description: Passed scorecards on this page.

Restrictions
Minimum	≥ 0

14.1.6. Property sections

Type	array of object

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

14.1.6.1. sections items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ name	No	string	No	-	Section name.
- hint	No	string	No	-	Informative text for the section.
+ score	No	integer	No	-	Percentage score for this section.
+ total_scorecards	No	integer	No	-	Total scorecards in this section.
+ passed_scorecards	No	integer	No	-	Passed scorecards in this section.
- levels_summary	No	object	No	-	-
- tags_summary	No	object	No	-	-
+ scorecards	No	array of object	No	-	-
- display	No	object	No	-	-

14.1.6.1.1. Property name

Type	string

Description: Section name.

14.1.6.1.2. Property hint

Type	string

Description: Informative text for the section.

14.1.6.1.3. Property score

Type	integer

Description: Percentage score for this section.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

14.1.6.1.4. Property total_scorecards

Type	integer

Description: Total scorecards in this section.

Restrictions
Minimum	≥ 0

14.1.6.1.5. Property passed_scorecards

Type	integer

Description: Passed scorecards in this section.

Restrictions
Minimum	≥ 0

14.1.6.1.6. Property levels_summary

Type	object
Additional properties

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

14.1.6.1.6.1. Property additionalProperties

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ total	No	integer	No	-	-
+ passed	No	integer	No	-	-
+ percentage	No	integer	No	-	-

14.1.6.1.6.1.1. Property total

Type	integer

Restrictions
Minimum	≥ 0

14.1.6.1.6.1.2. Property passed

Type	integer

Restrictions
Minimum	≥ 0

14.1.6.1.6.1.3. Property percentage

Type	integer

Restrictions
Minimum	≥ 0
Maximum	≤ 100

14.1.6.1.7. Property tags_summary

Type	object
Additional properties

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

14.1.6.1.7.1. Property additionalProperties

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ total	No	integer	No	-	-
+ passed	No	integer	No	-	-
+ percentage	No	integer	No	-	-

14.1.6.1.7.1.1. Property total

Type	integer

Restrictions
Minimum	≥ 0

14.1.6.1.7.1.2. Property passed

Type	integer

Restrictions
Minimum	≥ 0

14.1.6.1.7.1.3. Property percentage

Type	integer

Restrictions
Minimum	≥ 0
Maximum	≤ 100

14.1.6.1.8. Property scorecards

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

14.1.6.1.8.1. scorecards items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ name	No	string	No	-	Unique scorecard identifier.
+ description	No	string	No	-	Display description.
- level	No	string or null	No	-	Assigned severity level name.
- tags	No	array of string	No	-	Associated search tags.
- analyzers	No	array of string	No	-	Analyzers used for this scorecard.
+ passed	No	boolean	No	-	True if condition was met.
- status	No	enum (of string)	No	-	Execution status.
- condition	No	string	No	-	The JsonLogic expression evaluated.
- details	No	string	No	-	Detailed explanation of calculated result.

14.1.6.1.8.1.1. Property name

Type	string

Description: Unique scorecard identifier.

14.1.6.1.8.1.2. Property description

Type	string

Description: Display description.

14.1.6.1.8.1.3. Property level

Type	string or null

Description: Assigned severity level name.

14.1.6.1.8.1.4. Property tags

Type	array of string

Description: Associated search 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	-

14.1.6.1.8.1.4.1. tags items

Type	string

14.1.6.1.8.1.5. Property analyzers

Type	array of string

Description: Analyzers used for this scorecard.

	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	-

14.1.6.1.8.1.5.1. analyzers items

Type	string

14.1.6.1.8.1.6. Property passed

Type	boolean

Description: True if condition was met.

14.1.6.1.8.1.7. Property status

Type	enum (of string)

Description: Execution status.

Must be one of:

• "passed"
• "failed"
• "incomplete"

14.1.6.1.8.1.8. Property condition

Type	string

Description: The JsonLogic expression evaluated.

14.1.6.1.8.1.9. Property details

Type	string

Description: Detailed explanation of calculated result.

14.1.6.1.9. Property display

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
- analyzers	No	array of string	No	-	-
- widgets	No	array of object	No	-	-

14.1.6.1.9.1. Property analyzers

Type	array of string

	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	-

14.1.6.1.9.1.1. analyzers items

Type	string

14.1.6.1.9.2. Property widgets

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

14.1.6.1.9.2.1. widgets items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
- label	No	string	No	-	Widget display label.
- value	No	string	No	-	Data resolution path.
- icon	No	string	No	-	Icon identifier or emoji.
- resolved_value	No	object	No	-	The actual value fetched after resolution.

14.1.6.1.9.2.1.1. Property label

Type	string

Description: Widget display label.

14.1.6.1.9.2.1.2. Property value

Type	string

Description: Data resolution path.

14.1.6.1.9.2.1.3. Property icon

Type	string

Description: Icon identifier or emoji.

14.1.6.1.9.2.1.4. Property resolved_value

Type	object
Additional properties

Description: The actual value fetched after resolution.

15. Property checklists

Type	array of object

Description: Resolved checklists surfaced to downstream 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
checklists items	-

15.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 of object	No	-	-

15.1.1. Property title

Type	string

Description: Display title for the checklist.

15.1.2. Property items

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

15.1.2.1. items items

Type	object
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ label	No	string	No	-	-
+ checked	No	boolean	No	-	-

15.1.2.1.1. Property label

Type	string

15.1.2.1.2. Property checked

Type	boolean

16. Property templates

Type	array of object

Description: Cookiecutter templates surfaced to downstream 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	-

16.1. templates items

Type	combining
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
- url	No	string	No	-	-
- package	No	string	No	-	-
- directory	No	string	No	-	-

Any of(Option)
item 0
item 1

16.1.1. Property item 0

Type	object
Additional properties

16.1.1.1. The following properties are required

• url

16.1.2. Property item 1

Type	object
Additional properties

16.1.2.1. The following properties are required

• package

16.1.3. Property url

Type	string

16.1.4. Property package

Type	string

16.1.5. Property directory

Type	string

---

Generated using json-schema-for-humans on 2026-06-08 at 18:23:59 +0000