Skip to content

Commit cc3103d

Browse files
committed
docs: adr for sbom dashboard
1 parent 894a499 commit cc3103d

File tree

5 files changed

+45
-0
lines changed

5 files changed

+45
-0
lines changed

docs/adrs/00007-sbom-dashbord.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 00007. Sbom dashboard.
2+
3+
Date: 2025-04-27
4+
5+
## Status
6+
7+
DRAFT
8+
9+
## Context
10+
This ADR document is intended to define and implement the backend logic for the heard of SBOM dashboard in the UI.
11+
12+
Its mockup design document is as follows.
13+
![header-dashbord.png](header-dashbord.png)
14+
### This dashboard's header can be divided into three parts:
15+
- sbom state
16+
![sbom-status.png](sbom-status.png)
17+
The information includes two components: the total sum of the Packages and the total sum of individual licenses (with Policy Violations removed).
18+
- Vulnerabilities state
19+
![v11y-state.png](v11y-state.png)
20+
It also contains the total number of Vulnerabilities, as well as the count for each severity level.
21+
- sbom info
22+
![sbom-info.png](sbom-info.png)
23+
24+
## Decision
25+
Design an endpoint for each of these parts.
26+
- sbom state
27+
- **HTTP GET api//v2/sbom/{id}/sbom-status**
28+
- Reponse playload
29+
```json
30+
{
31+
"total_packages": "0",
32+
"total_licenses": "0"
33+
}
34+
```
35+
- Vulnerabilities state
36+
- **HTTP GET api//v2/sbom/{id}/vulnerabilities-status**
37+
- - Reponse playload
38+
```json
39+
{
40+
"total_vulnerabilities": "0",
41+
"total_high": "0",
42+
"total_medium": "0",
43+
"total_low": "0"
44+
}
45+
```

docs/adrs/header-dashbord.png

233 KB
Loading

docs/adrs/sbom-info.png

72.5 KB
Loading

docs/adrs/sbom-status.png

89.6 KB
Loading

docs/adrs/v11y-state.png

61.6 KB
Loading

0 commit comments

Comments
 (0)