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	In playbook_result.schema.json	Primary playbook result (shorthand for playbooks[0]).
- 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	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

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.schema.json	😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

8.1. playbook_result.schema.json

Type	object
Additional properties
Defined in	playbook_result.schema.json

Description: 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

9. Property playbook

Type	object
Additional properties
Defined in	playbook_result.schema.json

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

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-20 at 04:11:57 +0100