Version: v0.35.0

report

Title: report


Type	`object`
Additional properties

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

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ schemaVersion	No	integer	No	-	Report-structure contract version. Downstream consumers gate rendering on this. Distinct from `version` (package/snapshot).
+ version	No	string or null	No	-	Version of regis that generated this report.
- snapshot_date	No	string	No	-	ISO 8601 date when this version was snapshotted in the doc site.
- 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 (from --meta). Optional namespace exposed to rules as 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 `schemaVersion`


Type	`integer`

Description: Report-structure contract version. Downstream consumers gate rendering on this. Distinct from version (package/snapshot).

Restrictions
Minimum	≥ 1

2. Property `version`


Type	`string or null`

Description: Version of regis that generated this report.

3. Property `snapshot_date`


Type	`string`

Description: ISO 8601 date when this version was snapshotted in the doc site.

4. Property `tier`


Type	`string or null`

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

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	-

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

5.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the badge.

5.1.2. Property `scope`


Type	`string`

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

5.1.3. Property `value`


Type	`string or null`

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

5.1.4. Property `class`


Type	`enum (of string)`

Description: Visual style indicator.

Must be one of:

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

5.1.5. Property `label`


Type	`string`

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

6. Property `metadata`


Type	`object`
Additional properties

Description: Arbitrary user-provided metadata (from --meta). Optional namespace exposed to rules as metadata.*.

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

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

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

7.1.1. Property `label`


Type	`string`

Description: Display label for the link.

7.1.2. Property `url`


Type	`string`

Description: Target URL.

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

8.1. Property `url`


Type	`string`

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

8.2. Property `registry`


Type	`string`

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

8.3. Property `repository`


Type	`string`

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

8.4. Property `tag`


Type	`string`

Description: Image tag that was analyzed.

8.5. Property `digest`


Type	`string or null`

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

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

8.6.1. analyzers items


Type	`string`

8.7. Property `timestamp`


Type	`string`
Format	`date-time`

Description: ISO 8601 UTC timestamp of the analysis.

9. Property `results`


Type	`object`
Additional properties

Description: Analyzer results keyed by analyzer name.

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

9.1. Property `additionalProperties`


Type	`object`
Additional properties

10. 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, containing metadata and analyzer results.

10.1. playbook.result

Title: playbook.result


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

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.

10.1.1. Property `playbook_name`


Type	`string`

Description: Identifier of the playbook that was executed.

10.1.2. Property `playbook_version`


Type	`string or null`

Description: SemVer of the playbook that produced this report.

10.1.3. Property `api_version`


Type	`string or null`

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

10.1.4. Property `sidebar`


Type	`object`
Additional properties

Description: Sidebar navigation metadata for the report UI.

10.1.5. Property `version`


Type	`string or null`

Description: Version of regis that generated this report.

10.1.6. Property `tier`


Type	`string or null`

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

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

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

10.1.7.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the badge.

10.1.7.1.2. Property `scope`


Type	`string`

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

10.1.7.1.3. Property `value`


Type	`string or null`

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

10.1.7.1.4. Property `class`


Type	`enum (of string)`

Description: Visual style indicator.

Must be one of:

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

10.1.7.1.5. Property `label`


Type	`string`

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

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

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

10.1.8.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the rule.

10.1.8.1.2. Property `description`


Type	`string`

Description: Human-readable name of the rule.

10.1.8.1.3. Property `level`


Type	`string`

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

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

10.1.8.1.4.1. tags items


Type	`string`

10.1.8.1.5. Property `passed`


Type	`boolean`

Description: Whether the rule criteria were met.

10.1.8.1.6. Property `status`


Type	`enum (of string)`

Description: Detailed execution status.

Must be one of:

"passed"
"failed"
"incomplete"

10.1.8.1.7. Property `message`


Type	`string`

Description: Reasoning or details for the rule result.

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

10.1.8.1.8.1. analyzers items


Type	`string`

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

10.1.9.1. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

10.1.9.2.1. total items


Type	`string`

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

10.1.9.3.1. passed items


Type	`string`

10.1.9.4. Property `by_tag`


Type	`object`
Additional properties

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

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

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

10.1.9.4.1.1.1. rules items


Type	`string`

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

10.1.9.4.1.2.1. passed_rules items


Type	`string`

10.1.9.4.1.3. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10.1.10. Property `score`


Type	`integer`

Description: Overall percentage score for the playbook.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10.1.11. Property `total_scorecards`


Type	`integer`

Description: Total number of scorecards evaluated.

Restrictions
Minimum	≥ 0

10.1.12. Property `passed_scorecards`


Type	`integer`

Description: Number of scorecards that passed.

Restrictions
Minimum	≥ 0

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

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

10.1.13.1.1. Property `label`


Type	`string`

Description: Display label for the link.

10.1.13.1.2. Property `url`


Type	`string`

Description: Target URL.

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

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

10.1.14.1.1. Property `title`


Type	`string`

Description: Page title.

10.1.14.1.2. Property `slug`


Type	`string or null`

Description: URL-friendly identifier for the page.

10.1.14.1.3. Property `score`


Type	`integer`

Description: Percentage score for this page.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10.1.14.1.4. Property `total_scorecards`


Type	`integer`

Description: Total scorecards on this page.

Restrictions
Minimum	≥ 0

10.1.14.1.5. Property `passed_scorecards`


Type	`integer`

Description: Passed scorecards on this page.

Restrictions
Minimum	≥ 0

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

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

10.1.14.1.6.1.1. Property `name`


Type	`string`

Description: Section name.

10.1.14.1.6.1.2. Property `hint`


Type	`string`

Description: Informative text for the section.

10.1.14.1.6.1.3. Property `score`


Type	`integer`

Description: Percentage score for this section.

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10.1.14.1.6.1.4. Property `total_scorecards`


Type	`integer`

Description: Total scorecards in this section.

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.5. Property `passed_scorecards`


Type	`integer`

Description: Passed scorecards in this section.

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.6. Property `levels_summary`


Type	`object`
Additional properties

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

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

10.1.14.1.6.1.6.1.1. Property `total`


Type	`integer`

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.6.1.2. Property `passed`


Type	`integer`

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.6.1.3. Property `percentage`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

10.1.14.1.6.1.7. Property `tags_summary`


Type	`object`
Additional properties

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

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

10.1.14.1.6.1.7.1.1. Property `total`


Type	`integer`

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.7.1.2. Property `passed`


Type	`integer`

Restrictions
Minimum	≥ 0

10.1.14.1.6.1.7.1.3. Property `percentage`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

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

10.1.14.1.6.1.8.1.1. Property `name`


Type	`string`

Description: Unique scorecard identifier.

10.1.14.1.6.1.8.1.2. Property `description`


Type	`string`

Description: Display description.

10.1.14.1.6.1.8.1.3. Property `level`


Type	`string or null`

Description: Assigned severity level name.

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

10.1.14.1.6.1.8.1.4.1. tags items


Type	`string`

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

10.1.14.1.6.1.8.1.5.1. analyzers items


Type	`string`

10.1.14.1.6.1.8.1.6. Property `passed`


Type	`boolean`

Description: True if condition was met.

10.1.14.1.6.1.8.1.7. Property `status`


Type	`enum (of string)`

Description: Execution status.

Must be one of:

"passed"
"failed"
"incomplete"

10.1.14.1.6.1.8.1.8. Property `condition`


Type	`string`

Description: The JsonLogic expression evaluated.

10.1.14.1.6.1.8.1.9. Property `details`


Type	`string`

Description: Detailed explanation of calculated result.

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

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

10.1.14.1.6.1.9.1.1. analyzers items


Type	`string`

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

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

10.1.14.1.6.1.9.2.1.1. Property `label`


Type	`string`

Description: Widget display label.

10.1.14.1.6.1.9.2.1.2. Property `value`


Type	`string`

Description: Data resolution path.

10.1.14.1.6.1.9.2.1.3. Property `icon`


Type	`string`

Description: Icon identifier or emoji.

10.1.14.1.6.1.9.2.1.4. Property `resolved_value`


Type	`object`
Additional properties

Description: The actual value fetched after resolution.

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

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

10.1.15.1.1. Property `title`


Type	`string`

Description: Display title for the checklist.

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

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

10.1.15.1.2.1.1. Property `label`


Type	`string`

10.1.15.1.2.1.2. Property `checked`


Type	`boolean`

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

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

10.1.16.1.1. Property `item 0`


Type	`object`
Additional properties

10.1.16.1.1.1. The following properties are required

10.1.16.1.2. Property `item 1`


Type	`object`
Additional properties

10.1.16.1.2.1. The following properties are required

package

10.1.16.1.3. Property `url`


Type	`string`

10.1.16.1.4. Property `package`


Type	`string`

10.1.16.1.5. Property `directory`


Type	`string`

11. Property `playbook`

Title: playbook.result


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

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

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

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

12.1.1. Property `slug`


Type	`string`

Description: Unique identifier for the rule.

12.1.2. Property `description`


Type	`string`

Description: Human-readable name of the rule.

12.1.3. Property `level`


Type	`string`

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

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

12.1.4.1. tags items


Type	`string`

12.1.5. Property `passed`


Type	`boolean`

Description: Whether the rule criteria were met.

12.1.6. Property `status`


Type	`enum (of string)`

Description: Detailed execution status.

Must be one of:

"passed"
"failed"
"incomplete"

12.1.7. Property `message`


Type	`string`

Description: Reasoning or details for the rule result.

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

12.1.8.1. analyzers items


Type	`string`

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

13.1. Property `score`


Type	`integer`

Restrictions
Minimum	≥ 0
Maximum	≤ 100

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

13.2.1. total items


Type	`string`

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

13.3.1. passed items


Type	`string`

13.4. Property `by_tag`


Type	`object`
Additional properties

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

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

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

13.4.1.1.1. rules items


Type	`string`

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

13.4.1.2.1. passed_rules items


Type	`string`

13.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-06-08 at 18:23:59 +0000

1. Property schemaVersion​

2. Property version​

3. Property snapshot_date​

4. Property tier​

5. Property badges​

5.1. badges items​

5.1.1. Property slug​

5.1.2. Property scope​

5.1.3. Property value​

5.1.4. Property class​

5.1.5. Property label​

6. Property metadata​

7. Property links​

7.1. links items​

7.1.1. Property label​

7.1.2. Property url​

8. Property request​

8.1. Property url​

8.2. Property registry​

8.3. Property repository​

8.4. Property tag​

8.5. Property digest​

8.6. Property analyzers​

8.6.1. analyzers items​

8.7. Property timestamp​

9. Property results​

9.1. Property additionalProperties​

10. Property playbooks​

10.1. playbook.result​

10.1.1. Property playbook_name​

10.1.2. Property playbook_version​

10.1.3. Property api_version​

10.1.4. Property sidebar​

10.1.5. Property version​

10.1.6. Property tier​

10.1.7. Property badges​

10.1.7.1. badges items​

10.1.7.1.1. Property slug​

10.1.7.1.2. Property scope​

10.1.7.1.3. Property value​

10.1.7.1.4. Property class​

10.1.7.1.5. Property label​

10.1.8. Property rules​

10.1.8.1. rules items​

10.1.8.1.1. Property slug​

10.1.8.1.2. Property description​

10.1.8.1.3. Property level​

10.1.8.1.4. Property tags​

10.1.8.1.4.1. tags items​

10.1.8.1.5. Property passed​

10.1.8.1.6. Property status​

10.1.8.1.7. Property message​

10.1.8.1.8. Property analyzers​

10.1.8.1.8.1. analyzers items​

10.1.9. Property rules_summary​

10.1.9.1. Property score​

10.1.9.2. Property total​

10.1.9.2.1. total items​

10.1.9.3. Property passed​

10.1.9.3.1. passed items​

10.1.9.4. Property by_tag​

10.1.9.4.1. Property additionalProperties​

10.1.9.4.1.1. Property rules​

10.1.9.4.1.1.1. rules items​

10.1.9.4.1.2. Property passed_rules​

10.1.9.4.1.2.1. passed_rules items​

10.1.9.4.1.3. Property score​

10.1.10. Property score​

10.1.11. Property total_scorecards​

10.1.12. Property passed_scorecards​

10.1.13. Property links​

10.1.13.1. links items​

10.1.13.1.1. Property label​

10.1.13.1.2. Property url​

10.1.14. Property pages​

10.1.14.1. pages items​

10.1.14.1.1. Property title​

10.1.14.1.2. Property slug​

10.1.14.1.3. Property score​

10.1.14.1.4. Property total_scorecards​

1. Property `schemaVersion`

2. Property `version`

3. Property `snapshot_date`

4. Property `tier`

5. Property `badges`

5.1. badges items

5.1.1. Property `slug`

5.1.2. Property `scope`

5.1.3. Property `value`

5.1.4. Property `class`

5.1.5. Property `label`

6. Property `metadata`

7. Property `links`

7.1. links items

7.1.1. Property `label`

7.1.2. Property `url`

8. Property `request`

8.1. Property `url`

8.2. Property `registry`

8.3. Property `repository`

8.4. Property `tag`

8.5. Property `digest`

8.6. Property `analyzers`

8.6.1. analyzers items

8.7. Property `timestamp`

9. Property `results`

9.1. Property `additionalProperties`

10. Property `playbooks`

10.1. playbook.result

10.1.1. Property `playbook_name`

10.1.2. Property `playbook_version`

10.1.3. Property `api_version`

10.1.4. Property `sidebar`

10.1.5. Property `version`

10.1.6. Property `tier`

10.1.7. Property `badges`

10.1.7.1. badges items

10.1.7.1.1. Property `slug`

10.1.7.1.2. Property `scope`

10.1.7.1.3. Property `value`

10.1.7.1.4. Property `class`

10.1.7.1.5. Property `label`

10.1.8. Property `rules`

10.1.8.1. rules items

10.1.8.1.1. Property `slug`

10.1.8.1.2. Property `description`

10.1.8.1.3. Property `level`

10.1.8.1.4. Property `tags`

10.1.8.1.4.1. tags items

10.1.8.1.5. Property `passed`

10.1.8.1.6. Property `status`

10.1.8.1.7. Property `message`

10.1.8.1.8. Property `analyzers`

10.1.8.1.8.1. analyzers items

10.1.9. Property `rules_summary`

10.1.9.1. Property `score`

10.1.9.2. Property `total`

10.1.9.2.1. total items

10.1.9.3. Property `passed`

10.1.9.3.1. passed items

10.1.9.4. Property `by_tag`

10.1.9.4.1. Property `additionalProperties`

10.1.9.4.1.1. Property `rules`

10.1.9.4.1.1.1. rules items

10.1.9.4.1.2. Property `passed_rules`

10.1.9.4.1.2.1. passed_rules items

10.1.9.4.1.3. Property `score`

10.1.10. Property `score`

10.1.11. Property `total_scorecards`

10.1.12. Property `passed_scorecards`

10.1.13. Property `links`

10.1.13.1. links items

10.1.13.1.1. Property `label`

10.1.13.1.2. Property `url`

10.1.14. Property `pages`

10.1.14.1. pages items

10.1.14.1.1. Property `title`

10.1.14.1.2. Property `slug`

10.1.14.1.3. Property `score`

10.1.14.1.4. Property `total_scorecards`