Version: main-dev

report

Title: report


Type	`object`
Additional properties

Description: Final report envelope produced by regis-cli, containing request metadata and analyzer results.

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ version	No	string or null	No	-	Version of regis-cli 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	-	-
- metadata	No	object	No	-	Arbitrary user-provided metadata.
- links	No	array of object	No	-	Custom templated links.
+ request	No	object	No	-	Metadata describing the analysis request.
+ results	No	object	No	-	Analyzer results keyed by analyzer name.
- playbooks	No	array	No	-	List of evaluated playbook results.
- playbook	No	object	No	Same as playbook.result	playbook.result
- rules	No	array of object	No	-	List of unified rule results (promoted from playbooks[0]).
- rules_summary	No	object	No	-	Summary of rule evaluation results.

1. Property `version`


Type	`string or null`

Description: Version of regis-cli that generated this report.

2. Property `tier`


Type	`string or null`

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

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

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

3.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the badge.

3.1.2. Property `scope`


Type	`string`

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

3.1.3. Property `value`


Type	`string or null`

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

3.1.4. Property `class`


Type	`enum (of string)`

Description: Visual style indicator.

Must be one of:

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

3.1.5. Property `label`


Type	`string`

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

4. Property `metadata`


Type	`object`
Additional properties

Description: Arbitrary user-provided metadata.

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

5. Property `links`


Type	`array of object`

Description: Custom templated links.

	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	-

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

5.1.1. Property `label`


Type	`string`

Description: Display label for the link.

5.1.2. Property `url`


Type	`string`

Description: Target URL.

6. Property `request`


Type	`object`
Additional properties

Description: Metadata describing the analysis request.

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ url	No	string	No	-	Original URL or image reference provided by the user.
+ registry	No	string	No	-	Resolved registry hostname (e.g. registry-1.docker.io).
+ repository	No	string	No	-	Full repository path (e.g. library/nginx).
+ tag	No	string	No	-	Image tag that was analyzed.
- digest	No	string or null	No	-	Resolved image manifest digest (e.g. sha256-xxx), if available.
+ analyzers	No	array of string	No	-	List of analyzer names that were executed.
+ timestamp	No	string	No	-	ISO 8601 UTC timestamp of the analysis.
- metadata	No	object	No	-	Arbitrary user-provided metadata.

6.1. Property `url`


Type	`string`

Description: Original URL or image reference provided by the user.

6.2. Property `registry`


Type	`string`

Description: Resolved registry hostname (e.g. registry-1.docker.io).

6.3. Property `repository`


Type	`string`

Description: Full repository path (e.g. library/nginx).

6.4. Property `tag`


Type	`string`

Description: Image tag that was analyzed.

6.5. Property `digest`


Type	`string or null`

Description: Resolved image manifest digest (e.g. sha256-xxx), if available.

6.6. Property `analyzers`


Type	`array of string`

Description: List of analyzer names that were executed.

	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	-

6.6.1. analyzers items


Type	`string`

6.7. Property `timestamp`


Type	`string`
Format	`date-time`

Description: ISO 8601 UTC timestamp of the analysis.

6.8. Property `metadata`


Type	`object`
Additional properties

Description: Arbitrary user-provided metadata.

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

7. Property `results`


Type	`object`
Additional properties

Description: Analyzer results keyed by analyzer name.

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

7.1. Property `additionalProperties`


Type	`object`
Additional properties

8. Property `playbooks`


Type	`array`

Description: List of evaluated playbook results.

	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
playbook.result	Final playbook result produced by regis-cli, containing metadata and analyzer results.

8.1. playbook.result

Title: playbook.result


Type	`object`
Additional properties
Defined in	../playbook/result.schema.json

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

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ playbook_name	No	string	No	-	Identifier of the playbook that was executed.
- sidebar	No	object	No	-	Sidebar navigation metadata for the report UI.
- version	No	string or null	No	-	Version of regis-cli 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	-	-
- mr_templates	No	array of object	No	-	Cookiecutter templates to be run for MR descriptions.

8.1.1. Property `playbook_name`


Type	`string`

Description: Identifier of the playbook that was executed.

8.1.2. Property `sidebar`


Type	`object`
Additional properties

Description: Sidebar navigation metadata for the report UI.

8.1.3. Property `version`


Type	`string or null`

Description: Version of regis-cli that generated this report.

8.1.4. Property `tier`


Type	`string or null`

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

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

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

8.1.5.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the badge.

8.1.5.1.2. Property `scope`


Type	`string`

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

8.1.5.1.3. Property `value`


Type	`string or null`

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

8.1.5.1.4. Property `class`


Type	`enum (of string)`

Description: Visual style indicator.

Must be one of:

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

8.1.5.1.5. Property `label`


Type	`string`

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

8.1.6. 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.6.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.6.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the rule.

8.1.6.1.2. Property `description`


Type	`string`

Description: Human-readable name of the rule.

8.1.6.1.3. Property `level`


Type	`string`

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

8.1.6.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.6.1.4.1. tags items


Type	`string`

8.1.6.1.5. Property `passed`


Type	`boolean`

Description: Whether the rule criteria were met.

8.1.6.1.6. Property `status`


Type	`enum (of string)`

Description: Detailed execution status.

Must be one of:

"passed"
"failed"
"incomplete"

8.1.6.1.7. Property `message`


Type	`string`

Description: Reasoning or details for the rule result.

8.1.6.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.6.1.8.1. analyzers items


Type	`string`

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

8.1.7.1. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

8.1.7.2.1. total items


Type	`string`

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

8.1.7.3.1. passed items


Type	`string`

8.1.7.4. Property `by_tag`


Type	`object`
Additional properties

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

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

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

8.1.7.4.1.1.1. rules items


Type	`string`

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

8.1.7.4.1.2.1. passed_rules items


Type	`string`

8.1.7.4.1.3. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

8.1.8. Property `score`


Type	`integer`

Description: Overall percentage score for the playbook.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

8.1.9. Property `total_scorecards`


Type	`integer`

Description: Total number of scorecards evaluated.

Restrictions
Minimum	≥ 0

8.1.10. Property `passed_scorecards`


Type	`integer`

Description: Number of scorecards that passed.

Restrictions
Minimum	≥ 0

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

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

8.1.11.1.1. Property `label`


Type	`string`

Description: Display label for the link.

8.1.11.1.2. Property `url`


Type	`string`

Description: Target URL.

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

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

8.1.12.1.1. Property `title`


Type	`string`

Description: Page title.

8.1.12.1.2. Property `slug`


Type	`string or null`

Description: URL-friendly identifier for the page.

8.1.12.1.3. Property `score`


Type	`integer`

Description: Percentage score for this page.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

8.1.12.1.4. Property `total_scorecards`


Type	`integer`

Description: Total scorecards on this page.

Restrictions
Minimum	≥ 0

8.1.12.1.5. Property `passed_scorecards`


Type	`integer`

Description: Passed scorecards on this page.

Restrictions
Minimum	≥ 0

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

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

8.1.12.1.6.1.1. Property `name`


Type	`string`

Description: Section name.

8.1.12.1.6.1.2. Property `hint`


Type	`string`

Description: Informative text for the section.

8.1.12.1.6.1.3. Property `score`


Type	`integer`

Description: Percentage score for this section.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

8.1.12.1.6.1.4. Property `total_scorecards`


Type	`integer`

Description: Total scorecards in this section.

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.5. Property `passed_scorecards`


Type	`integer`

Description: Passed scorecards in this section.

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.6. Property `levels_summary`


Type	`object`
Additional properties

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

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

8.1.12.1.6.1.6.1.1. Property `total`


Type	`integer`

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.6.1.2. Property `passed`


Type	`integer`

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.6.1.3. Property `percentage`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

8.1.12.1.6.1.7. Property `tags_summary`


Type	`object`
Additional properties

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

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

8.1.12.1.6.1.7.1.1. Property `total`


Type	`integer`

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.7.1.2. Property `passed`


Type	`integer`

Restrictions
Minimum	≥ 0

8.1.12.1.6.1.7.1.3. Property `percentage`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

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

8.1.12.1.6.1.8.1.1. Property `name`


Type	`string`

Description: Unique scorecard identifier.

8.1.12.1.6.1.8.1.2. Property `description`


Type	`string`

Description: Display description.

8.1.12.1.6.1.8.1.3. Property `level`


Type	`string or null`

Description: Assigned severity level name.

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

8.1.12.1.6.1.8.1.4.1. tags items


Type	`string`

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

8.1.12.1.6.1.8.1.5.1. analyzers items


Type	`string`

8.1.12.1.6.1.8.1.6. Property `passed`


Type	`boolean`

Description: True if condition was met.

8.1.12.1.6.1.8.1.7. Property `status`


Type	`enum (of string)`

Description: Execution status.

Must be one of:

"passed"
"failed"
"incomplete"

8.1.12.1.6.1.8.1.8. Property `condition`


Type	`string`

Description: The JsonLogic expression evaluated.

8.1.12.1.6.1.8.1.9. Property `details`


Type	`string`

Description: Detailed explanation of calculated result.

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

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

8.1.12.1.6.1.9.1.1. analyzers items


Type	`string`

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

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

8.1.12.1.6.1.9.2.1.1. Property `label`


Type	`string`

Description: Widget display label.

8.1.12.1.6.1.9.2.1.2. Property `value`


Type	`string`

Description: Data resolution path.

8.1.12.1.6.1.9.2.1.3. Property `icon`


Type	`string`

Description: Icon identifier or emoji.

8.1.12.1.6.1.9.2.1.4. Property `resolved_value`


Type	`object`
Additional properties

Description: The actual value fetched after resolution.

8.1.13. Property `mr_templates`


Type	`array of object`

Description: Cookiecutter templates to be run for MR descriptions.

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

8.1.13.1. mr_templates items


Type	`object`
Additional properties

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

8.1.13.1.1. Property `url`


Type	`string`

8.1.13.1.2. Property `directory`


Type	`string`

9. Property `playbook`

Title: playbook.result


Type	`object`
Additional properties
Same definition as	playbook.result

Description: Primary playbook result (shorthand for playbooks[0]).

10. Property `rules`


Type	`array of object`

Description: List of unified rule results (promoted from playbooks[0]).

	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	-

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

10.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the rule.

10.1.2. Property `description`


Type	`string`

Description: Human-readable name of the rule.

10.1.3. Property `level`


Type	`string`

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

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

10.1.4.1. tags items


Type	`string`

10.1.5. Property `passed`


Type	`boolean`

Description: Whether the rule criteria were met.

10.1.6. Property `status`


Type	`enum (of string)`

Description: Detailed execution status.

Must be one of:

"passed"
"failed"
"incomplete"

10.1.7. Property `message`


Type	`string`

Description: Reasoning or details for the rule result.

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

10.1.8.1. analyzers items


Type	`string`

11. Property `rules_summary`


Type	`object`
Additional properties

Description: Summary of rule evaluation results.

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

11.1. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

11.2.1. total items


Type	`string`

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

11.3.1. passed items


Type	`string`

11.4. Property `by_tag`


Type	`object`
Additional properties

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

11.4.1. Property `additionalProperties`


Type	`object`
Additional properties

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ rules	No	array of string	No	-	List of rule slugs in this group.
+ passed_rules	No	array of string	No	-	List of slugs for rules that passed.
+ score	No	integer	No	-	Percentage score for this group.

11.4.1.1. Property `rules`


Type	`array of string`

Description: List of rule slugs in this group.

	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	-

11.4.1.1.1. rules items


Type	`string`

11.4.1.2. Property `passed_rules`


Type	`array of string`

Description: List of slugs for rules that passed.

	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	-

11.4.1.2.1. passed_rules items


Type	`string`

11.4.1.3. Property `score`


Type	`integer`

Description: Percentage score for this group.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

Generated using json-schema-for-humans on 2026-03-21 at 11:43:39 +0000

1. Property version​

2. Property tier​

3. Property badges​

3.1. badges items​

3.1.1. Property slug​

3.1.2. Property scope​

3.1.3. Property value​

3.1.4. Property class​

3.1.5. Property label​

4. Property metadata​

5. Property links​

5.1. links items​

5.1.1. Property label​

5.1.2. Property url​

6. Property request​

6.1. Property url​

6.2. Property registry​

6.3. Property repository​

6.4. Property tag​

6.5. Property digest​

6.6. Property analyzers​

6.6.1. analyzers items​

6.7. Property timestamp​

6.8. Property metadata​

7. Property results​

7.1. Property additionalProperties​

8. Property playbooks​

8.1. playbook.result​

8.1.1. Property playbook_name​

8.1.2. Property sidebar​

8.1.3. Property version​

8.1.4. Property tier​

8.1.5. Property badges​

8.1.5.1. badges items​

8.1.5.1.1. Property slug​

8.1.5.1.2. Property scope​

8.1.5.1.3. Property value​

8.1.5.1.4. Property class​

8.1.5.1.5. Property label​

8.1.6. Property rules​

8.1.6.1. rules items​

8.1.6.1.1. Property slug​

8.1.6.1.2. Property description​

8.1.6.1.3. Property level​

8.1.6.1.4. Property tags​

8.1.6.1.4.1. tags items​

8.1.6.1.5. Property passed​

8.1.6.1.6. Property status​

8.1.6.1.7. Property message​

8.1.6.1.8. Property analyzers​

8.1.6.1.8.1. analyzers items​

8.1.7. Property rules_summary​

8.1.7.1. Property score​

8.1.7.2. Property total​

8.1.7.2.1. total items​

8.1.7.3. Property passed​

8.1.7.3.1. passed items​

8.1.7.4. Property by_tag​

8.1.7.4.1. Property additionalProperties​

8.1.7.4.1.1. Property rules​

8.1.7.4.1.1.1. rules items​

8.1.7.4.1.2. Property passed_rules​

8.1.7.4.1.2.1. passed_rules items​

8.1.7.4.1.3. Property score​

8.1.8. Property score​

8.1.9. Property total_scorecards​

8.1.10. Property passed_scorecards​

8.1.11. Property links​

8.1.11.1. links items​

8.1.11.1.1. Property label​

8.1.11.1.2. Property url​

8.1.12. Property pages​

8.1.12.1. pages items​

8.1.12.1.1. Property title​

8.1.12.1.2. Property slug​

8.1.12.1.3. Property score​

8.1.12.1.4. Property total_scorecards​

8.1.12.1.5. Property passed_scorecards​

8.1.12.1.6. Property sections​

8.1.12.1.6.1. sections items​

1. Property `version`

2. Property `tier`

3. Property `badges`

3.1. badges items

3.1.1. Property `slug`

3.1.2. Property `scope`

3.1.3. Property `value`

3.1.4. Property `class`

3.1.5. Property `label`

4. Property `metadata`

5. Property `links`

5.1. links items

5.1.1. Property `label`

5.1.2. Property `url`

6. Property `request`

6.1. Property `url`

6.2. Property `registry`

6.3. Property `repository`

6.4. Property `tag`

6.5. Property `digest`

6.6. Property `analyzers`

6.6.1. analyzers items

6.7. Property `timestamp`

6.8. Property `metadata`

7. Property `results`

7.1. Property `additionalProperties`

8. Property `playbooks`

8.1. playbook.result

8.1.1. Property `playbook_name`

8.1.2. Property `sidebar`

8.1.3. Property `version`

8.1.4. Property `tier`

8.1.5. Property `badges`

8.1.5.1. badges items

8.1.5.1.1. Property `slug`

8.1.5.1.2. Property `scope`

8.1.5.1.3. Property `value`

8.1.5.1.4. Property `class`

8.1.5.1.5. Property `label`

8.1.6. Property `rules`

8.1.6.1. rules items

8.1.6.1.1. Property `slug`

8.1.6.1.2. Property `description`

8.1.6.1.3. Property `level`

8.1.6.1.4. Property `tags`

8.1.6.1.4.1. tags items

8.1.6.1.5. Property `passed`

8.1.6.1.6. Property `status`

8.1.6.1.7. Property `message`

8.1.6.1.8. Property `analyzers`

8.1.6.1.8.1. analyzers items

8.1.7. Property `rules_summary`

8.1.7.1. Property `score`

8.1.7.2. Property `total`

8.1.7.2.1. total items

8.1.7.3. Property `passed`

8.1.7.3.1. passed items

8.1.7.4. Property `by_tag`

8.1.7.4.1. Property `additionalProperties`

8.1.7.4.1.1. Property `rules`

8.1.7.4.1.1.1. rules items

8.1.7.4.1.2. Property `passed_rules`

8.1.7.4.1.2.1. passed_rules items

8.1.7.4.1.3. Property `score`

8.1.8. Property `score`

8.1.9. Property `total_scorecards`

8.1.10. Property `passed_scorecards`

8.1.11. Property `links`

8.1.11.1. links items

8.1.11.1.1. Property `label`

8.1.11.1.2. Property `url`

8.1.12. Property `pages`

8.1.12.1. pages items

8.1.12.1.1. Property `title`

8.1.12.1.2. Property `slug`

8.1.12.1.3. Property `score`

8.1.12.1.4. Property `total_scorecards`

8.1.12.1.5. Property `passed_scorecards`

8.1.12.1.6. Property `sections`

8.1.12.1.6.1. sections items