Skip to content

Commit bb9f67b

Browse files
committed
improve schema descriptions and add new attributes
Signed-off-by: Johannes Zahn <johannes.zahn@iteratec.com>
1 parent 989f8b2 commit bb9f67b

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

parser-sdk/nodejs/findings-schema.json

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,35 @@
1010
"additionalProperties": false,
1111
"properties": {
1212
"id": {
13-
"description": "The unique identifier for a finding according to RFC 4122",
13+
"description": "The unique identifier for a Finding according to RFC4122.",
1414
"type": "string",
1515
"format": "uuid"
1616
},
17+
"identified_at": {
18+
"description": "Date-Time when the Finding was exactly identified according to ISO8601. This information will often not be present.",
19+
"type": "string",
20+
"format": "date-time"
21+
},
1722
"parsed_at": {
18-
"description": "Date-Time when the finding was parsed according to RFC3339",
23+
"description": "Date-Time when the Finding was aarsed according to ISO8601. This information will always be present.",
1924
"type": "string",
2025
"format": "date-time"
2126
},
2227
"name": {
23-
"description": "Name contains a short description of the finding",
28+
"description": "Contains a short description of the Finding.",
2429
"type": "string"
2530
},
2631
"description": {
27-
"description": "In depth description, can span multiple paragraphs",
32+
"description": "In depth description, can span multiple paragraphs.",
2833
"type": "string",
2934
"nullable": true
3035
},
3136
"category": {
32-
"description": "The category is often used to group finding based on their types",
37+
"description": "Is often used to group finding based on their types.",
3338
"type": "string"
3439
},
3540
"osi_layer": {
36-
"description": "OSI network layer the finding fits into",
41+
"description": "OSI Layer the finding fits into.",
3742
"type": "string",
3843
"enum": [
3944
"PHYSICAL",
@@ -46,7 +51,7 @@
4651
]
4752
},
4853
"severity": {
49-
"description": "One of INFORMATIONAL, LOW, MEDIUM, HIGH,",
54+
"description": "Indicates the severity of the finding.",
5055
"type": "string",
5156
"enum": [
5257
"INFORMATIONAL",
@@ -56,13 +61,12 @@
5661
]
5762
},
5863
"attributes": {
59-
"description": "Attributes are not standardized. They differ from scanner to scanner",
64+
"description": "Attributes are not standardized. They differ from Scanner to Scanner.",
6065
"type": "object"
6166
},
6267
"location": {
63-
"description": "Full url with protocol, port, and path if existing",
64-
"type": "string",
65-
"format": "uri"
68+
"description": "Full URL with protocol, port, and path if existing.",
69+
"type": "string"
6670
}
6771
},
6872
"required": [
@@ -73,6 +77,7 @@
7377
"osi_layer",
7478
"severity",
7579
"attributes",
80+
"parsed_at",
7681
"location"
7782
]
7883
}

0 commit comments

Comments
 (0)