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 of the playbook's rules that passed. |
| - links | No | array of object | No | - | External links associated with this playbook result. |
| - 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
Description: Identifier of the playbook that was executed.
2. 
Property playbook_version
Description: SemVer of the playbook that produced this report.
3. Property api_version
Description: apiVersion of the playbook that produced this result (e.g. "regis.io/v1alpha1").
| |
|---|
| Type | object |
| Additional properties | |
Description: Sidebar navigation metadata for the report UI.
5. Property version
Description: Version of regis that generated this report.
6. Property tier
Description: The earned tier (e.g. Gold, Silver, Bronze) based on playbook conditions.
7. Property badges
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
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
Description: Unique identifier for the badge.
7.1.2. Property scope
Description: Domain of the badge (e.g., 'security', 'hygiene').
7.1.3. Property value
Description: Display value or grade (e.g., 'A', '95%').
7.1.4. Property class
Description: Visual style indicator.
Must be one of:
- "success"
- "warning"
- "error"
- "information"
7.1.5. Property label
Description: The full label string (scope or scope: value).
8. Property rules
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
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 | - | Severity level of the rule (e.g. critical, warning, info). Distinct from the playbook tier. |
| - 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
Description: Unique identifier for the rule.
8.1.2. Property description
Description: Human-readable name of the rule.
8.1.3. Property level
Description: Severity level of the rule (e.g. critical, warning, info). Distinct from the playbook tier.
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.5. Property passed
Description: Whether the rule criteria were met.
8.1.6. Property status
Description: Detailed execution status.
Must be one of:
- "passed"
- "failed"
- "incomplete"
8.1.7. Property message
Description: Reasoning or details for the rule result.
8.1.8. Property analyzers
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 |
8.1.8.1. analyzers items
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
| Restrictions | |
|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 100 |
9.2. Property total
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
9.2.1. total items
9.3. Property passed
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
9.3.1. passed items
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
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
9.4.1.1.1. rules items
9.4.1.2. Property passed_rules
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
9.4.1.2.1. passed_rules items
9.4.1.3. Property score
| Restrictions | |
|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 100 |
10. Property score
Description: Overall percentage of the playbook's rules that passed.
| Restrictions | |
|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 100 |
11. Property links
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 |
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. |
11.1.1. Property label
Description: Display label for the link.
11.1.2. Property url
Description: Target URL.
12. Property checklists
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 |
12.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 | - | - |
12.1.1. Property title
Description: Display title for the checklist.
12.1.2. Property items
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
12.1.2.1. items items
| |
|---|
| Type | object |
| Additional properties | |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| + label | No | string | No | - | - |
| + checked | No | boolean | No | - | - |
12.1.2.1.1. Property label
12.1.2.1.2. Property checked
13. Property templates
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 |
13.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 | - | - |
13.1.1. Property item 0
| |
|---|
| Type | object |
| Additional properties | |
13.1.1.1. The following properties are required
13.1.2. Property item 1
| |
|---|
| Type | object |
| Additional properties | |
13.1.2.1. The following properties are required
13.1.3. Property url
13.1.4. Property package
13.1.5. Property directory
Generated using json-schema-for-humans on 2026-06-09 at 12:22:16 +0000