Skip to content

Commit 8fc3067

Browse files
authored
Refactor Root Cause Analysis blueprint schema
Removed duplicate schema properties and cleaned up JSON structure for Root Cause Analysis blueprint.
1 parent 7c4be86 commit 8fc3067

File tree

1 file changed

+71
-71
lines changed

1 file changed

+71
-71
lines changed

docs/guides/all/add-rca-context-to-ai-agents.md

Lines changed: 71 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -50,80 +50,80 @@ Follow the steps below to create the blueprint:
5050

5151
The entities of this blueprint will represent different RCA documents from past incidents.
5252

53-
```json showLineNumbers
54-
{
55-
"identifier": "rootCauseAnalysis",
56-
"title": "Root Cause Analysis",
57-
"icon": "Bug",
58-
"description": "Historical Root Cause Analysis documents from past incidents, including resolutions, lessons learned, and preventive measures",
59-
"schema": {
60-
"properties": {
61-
"summary": {
62-
"type": "string",
63-
"title": "Summary",
64-
"description": "Brief summary of the incident"
65-
},
66-
"incidentDate": {
67-
"type": "string",
68-
"format": "date-time",
69-
"title": "Incident Date",
70-
"description": "When the incident occurred"
71-
},
72-
"severity": {
73-
"type": "string",
74-
"title": "Severity",
75-
"enum": ["Critical", "High", "Medium", "Low"],
76-
"enumColors": {
77-
"Critical": "red",
78-
"High": "orange",
79-
"Medium": "yellow",
80-
"Low": "green"
53+
```json showLineNumbers
54+
{
55+
"identifier": "rootCauseAnalysis",
56+
"title": "Root Cause Analysis",
57+
"icon": "Bug",
58+
"description": "Historical Root Cause Analysis documents from past incidents, including resolutions, lessons learned, and preventive measures",
59+
"schema": {
60+
"properties": {
61+
"summary": {
62+
"type": "string",
63+
"title": "Summary",
64+
"description": "Brief summary of the incident"
65+
},
66+
"incidentDate": {
67+
"type": "string",
68+
"format": "date-time",
69+
"title": "Incident Date",
70+
"description": "When the incident occurred"
71+
},
72+
"severity": {
73+
"type": "string",
74+
"title": "Severity",
75+
"enum": ["Critical", "High", "Medium", "Low"],
76+
"enumColors": {
77+
"Critical": "red",
78+
"High": "orange",
79+
"Medium": "yellow",
80+
"Low": "green"
81+
}
82+
},
83+
"affectedServices": {
84+
"type": "array",
85+
"title": "Affected Services",
86+
"description": "Services impacted by this incident"
87+
},
88+
"rootCause": {
89+
"type": "string",
90+
"format": "markdown",
91+
"title": "Root Cause",
92+
"description": "Detailed analysis of what caused the incident"
93+
},
94+
"resolution": {
95+
"type": "string",
96+
"format": "markdown",
97+
"title": "Resolution",
98+
"description": "How the incident was resolved"
99+
},
100+
"preventiveMeasures": {
101+
"type": "string",
102+
"format": "markdown",
103+
"title": "Preventive Measures",
104+
"description": "Actions taken to prevent similar incidents"
105+
},
106+
"lessonsLearned": {
107+
"type": "string",
108+
"format": "markdown",
109+
"title": "Lessons Learned",
110+
"description": "Key takeaways and learnings from this incident"
111+
},
112+
"tags": {
113+
"type": "array",
114+
"title": "Tags",
115+
"description": "Tags for categorizing and searching RCAs"
81116
}
117+
},
118+
"required": ["summary", "incidentDate", "severity", "rootCause", "resolution"]
82119
},
83-
"affectedServices": {
84-
"type": "array",
85-
"title": "Affected Services",
86-
"description": "Services impacted by this incident"
87-
},
88-
"rootCause": {
89-
"type": "string",
90-
"format": "markdown",
91-
"title": "Root Cause",
92-
"description": "Detailed analysis of what caused the incident"
93-
},
94-
"resolution": {
95-
"type": "string",
96-
"format": "markdown",
97-
"title": "Resolution",
98-
"description": "How the incident was resolved"
99-
},
100-
"preventiveMeasures": {
101-
"type": "string",
102-
"format": "markdown",
103-
"title": "Preventive Measures",
104-
"description": "Actions taken to prevent similar incidents"
105-
},
106-
"lessonsLearned": {
107-
"type": "string",
108-
"format": "markdown",
109-
"title": "Lessons Learned",
110-
"description": "Key takeaways and learnings from this incident"
111-
},
112-
"tags": {
113-
"type": "array",
114-
"title": "Tags",
115-
"description": "Tags for categorizing and searching RCAs"
120+
"mirrorProperties": {},
121+
"calculationProperties": {},
122+
"aggregationProperties": {},
123+
"relations": {}
116124
}
117-
},
118-
"required": ["summary", "incidentDate", "severity", "rootCause", "resolution"]
119-
},
120-
"mirrorProperties": {},
121-
"calculationProperties": {},
122-
"aggregationProperties": {},
123-
"relations": {}
124-
}
125-
```
126-
</details>
125+
```
126+
</details>
127127

128128
5. Click `Create` to save the blueprint.
129129

0 commit comments

Comments
 (0)