Skip to content

Commit 8708edf

Browse files
committed
LAB-989: [SHIELD] Minor changes - Remove unnecessary examples, use real uuids, add missing sections.
1 parent 629aa72 commit 8708edf

File tree

1 file changed

+29
-92
lines changed

1 file changed

+29
-92
lines changed

specs/SHIELD.json

Lines changed: 29 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1749,90 +1749,17 @@
17491749
}
17501750
]
17511751
},
1752-
"CspmPolicyAssessment": {
1753-
"title": "Discover - Cspm Policy Assessment Result",
1752+
"Discover.ArchitectureReport.CspmPolicyAssessment": {
1753+
"title": "Discover - Architecture Report - Cspm Policy Assessment Result",
17541754
"description": "Policy Assessment Result containing coverage calculations for the architecture report",
17551755
"type": "object",
17561756
"properties": {
17571757
"policyList": {
17581758
"type": "object",
17591759
"additionalProperties": {
1760-
"$ref": "#/components/schemas/CspmPolicyAssessment.PolicyRecord"
1760+
"$ref": "#/components/schemas/Discover.ArchitectureReport.CspmPolicyAssessment.PolicyRecord"
17611761
},
1762-
"description": "The mapping between ConfigurationItem templateIds and their corresponding policy record",
1763-
"examples": [
1764-
{
1765-
"11111111-1111-1111-1111-111111111111": {
1766-
"categoryList": [
1767-
"Access Control",
1768-
"Compliance"
1769-
],
1770-
"coverageMetricsNormalized": {
1771-
"covered": 80,
1772-
"noCover": 0,
1773-
"partial": 20
1774-
},
1775-
"coverageMetricsRaw": {
1776-
"covered": 8,
1777-
"noCover": 0,
1778-
"partial": 2
1779-
},
1780-
"coverageStatus": "full",
1781-
"name": "Sample Policy 1"
1782-
},
1783-
"22222222-2222-2222-2222-222222222222": {
1784-
"categoryList": [
1785-
"Data Protection"
1786-
],
1787-
"coverageMetricsNormalized": {
1788-
"covered": 50,
1789-
"noCover": 20,
1790-
"partial": 30
1791-
},
1792-
"coverageMetricsRaw": {
1793-
"covered": 5,
1794-
"noCover": 2,
1795-
"partial": 3
1796-
},
1797-
"coverageStatus": "partial",
1798-
"name": "Sample Policy 2"
1799-
},
1800-
"33333333-3333-3333-3333-333333333333": {
1801-
"categoryList": [
1802-
"Network Security"
1803-
],
1804-
"coverageMetricsNormalized": {
1805-
"covered": 0,
1806-
"noCover": 100,
1807-
"partial": 0
1808-
},
1809-
"coverageMetricsRaw": {
1810-
"covered": 0,
1811-
"noCover": 10,
1812-
"partial": 0
1813-
},
1814-
"coverageStatus": "none",
1815-
"name": "Sample Policy 3"
1816-
},
1817-
"44444444-4444-4444-4444-444444444444": {
1818-
"categoryList": [
1819-
"Identity Management"
1820-
],
1821-
"coverageMetricsNormalized": {
1822-
"covered": 70,
1823-
"noCover": 20,
1824-
"partial": 10
1825-
},
1826-
"coverageMetricsRaw": {
1827-
"covered": 7,
1828-
"noCover": 2,
1829-
"partial": 1
1830-
},
1831-
"coverageStatus": "partial",
1832-
"name": "Sample Policy 4"
1833-
}
1834-
}
1835-
]
1762+
"description": "The mapping between ConfigurationItem templateIds and their corresponding policy record"
18361763
},
18371764
"reportCreatedDate": {
18381765
"type": "string",
@@ -1857,7 +1784,7 @@
18571784
"examples": [
18581785
{
18591786
"policyList": {
1860-
"11111111-1111-1111-1111-111111111111": {
1787+
"e7b8c2a2-2e4a-4b6a-9c3d-8f1e2a7b6c4d": {
18611788
"categoryList": [
18621789
"Access Control",
18631790
"Compliance"
@@ -1875,7 +1802,7 @@
18751802
"coverageStatus": "full",
18761803
"name": "Sample Policy 1"
18771804
},
1878-
"22222222-2222-2222-2222-222222222222": {
1805+
"2a1e3c4d-5b6f-4e7a-8c9d-0f1b2a3c4d5e": {
18791806
"categoryList": [
18801807
"Data Protection"
18811808
],
@@ -1892,7 +1819,7 @@
18921819
"coverageStatus": "partial",
18931820
"name": "Sample Policy 2"
18941821
},
1895-
"33333333-3333-3333-3333-333333333333": {
1822+
"9f8e7d6c-5b4a-3c2e-1d0f-8a7b6c5d4e3f": {
18961823
"categoryList": [
18971824
"Network Security"
18981825
],
@@ -1909,7 +1836,7 @@
19091836
"coverageStatus": "none",
19101837
"name": "Sample Policy 3"
19111838
},
1912-
"44444444-4444-4444-4444-444444444444": {
1839+
"1f0e9d8c-7b6a-5c4d-3e2f-1a0b9c8d7e6f": {
19131840
"categoryList": [
19141841
"Identity Management"
19151842
],
@@ -1932,8 +1859,8 @@
19321859
}
19331860
]
19341861
},
1935-
"CspmPolicyAssessment.PolicyRecord": {
1936-
"title": "Discover - Cspm Policy Assessment Policy Record",
1862+
"Discover.ArchitectureReport.CspmPolicyAssessment.PolicyRecord": {
1863+
"title": "Discover - Architecture Report - Cspm Policy Assessment Policy Record",
19371864
"description": "Represents a policy record containing policy details along with user coverage metrics and status",
19381865
"type": "object",
19391866
"properties": {
@@ -1948,7 +1875,9 @@
19481875
]
19491876
},
19501877
"examples": [
1951-
"Sample Policy Name"
1878+
[
1879+
"Identity Management"
1880+
]
19521881
]
19531882
},
19541883
"name": {
@@ -1966,9 +1895,7 @@
19661895
"description": "The amount of users fully covered",
19671896
"type": "number",
19681897
"examples": [
1969-
0,
1970-
5,
1971-
10
1898+
5
19721899
]
19731900
},
19741901
"partial": {
@@ -1996,6 +1923,11 @@
19961923
"noCover": 2,
19971924
"partial": 1
19981925
}
1926+
],
1927+
"required": [
1928+
"covered",
1929+
"partial",
1930+
"noCover"
19991931
]
20001932
},
20011933
"coverageMetricsNormalized": {
@@ -2030,6 +1962,11 @@
20301962
"noCover": 20,
20311963
"partial": 10
20321964
}
1965+
],
1966+
"required": [
1967+
"covered",
1968+
"partial",
1969+
"noCover"
20331970
]
20341971
},
20351972
"coverageStatus": {
@@ -4031,7 +3968,7 @@
40313968
"summary": "Example CSPM Policy Assessment Response",
40323969
"value": {
40333970
"policyList": {
4034-
"11111111-1111-1111-1111-111111111111": {
3971+
"e7b8c2a2-2e4a-4b6a-9c3d-8f1e2a7b6c4d": {
40353972
"categoryList": [
40363973
"Access Control",
40373974
"Compliance"
@@ -4049,7 +3986,7 @@
40493986
"coverageStatus": "full",
40503987
"name": "Sample Policy 1"
40513988
},
4052-
"22222222-2222-2222-2222-222222222222": {
3989+
"2a1e3c4d-5b6f-4e7a-8c9d-0f1b2a3c4d5e": {
40533990
"categoryList": [
40543991
"Data Protection"
40553992
],
@@ -4066,7 +4003,7 @@
40664003
"coverageStatus": "partial",
40674004
"name": "Sample Policy 2"
40684005
},
4069-
"33333333-3333-3333-3333-333333333333": {
4006+
"9f8e7d6c-5b4a-3c2e-1d0f-8a7b6c5d4e3f": {
40704007
"categoryList": [
40714008
"Network Security"
40724009
],
@@ -4083,7 +4020,7 @@
40834020
"coverageStatus": "none",
40844021
"name": "Sample Policy 3"
40854022
},
4086-
"44444444-4444-4444-4444-444444444444": {
4023+
"1f0e9d8c-7b6a-5c4d-3e2f-1a0b9c8d7e6f": {
40874024
"categoryList": [
40884025
"Identity Management"
40894026
],
@@ -4107,7 +4044,7 @@
41074044
}
41084045
},
41094046
"schema": {
4110-
"$ref": "#/components/schemas/CspmPolicyAssessment"
4047+
"$ref": "#/components/schemas/Discover.ArchitectureReport.CspmPolicyAssessment"
41114048
}
41124049
}
41134050
},

0 commit comments

Comments
 (0)