doc(status): Update the status file template and fix markdown.
@@ -46,7 +46,6 @@ The file includes status codes, issues encountered and results produced. As addi
}
```
###Detector Status Codes
-
| Status Code | Description |
| --- | --- |
<#list statusCodes as statusCode>
@@ -65,17 +64,19 @@ The file includes status codes, issues encountered and results produced. As addi
```
{
"type": A key describing the type of issue, currently "EXCEPTION", "DEPRECATION" or "DETECTOR".
- "messages": A list of a strings describing the issue.
+"title": A string describing the issue.
+"messages": A list of a strings describing the details of the issue.
}
```
##Results
- A result is a URL or file path to output produced by the ${solution_name} run: a Black Duck Bill Of Materials, Risk Report, Notices Report, or Air Gap zip.
+A result is a URL, file path to output, or messages produced by the ${solution_name} run: a Black Duck Bill Of Materials, Risk Report, Notices Report, Air Gap zip, or Rapid Scan results.
```
{
"location": The path to the result.
"message": A string describing the result.
+"sub_messages": A list of strings providing more detail about the result.
}
```
@@ -91,14 +92,24 @@ The file includes status codes, issues encountered and results produced. As addi
}
```
+##Operations
+A list of information regarding internal execution of detect to describe when portions of detect run and what their status is.
+This information is intended to be used when detect fails and the reason for the failure needs to be determined.
+
+```
+"startTimestamp": A formatted UTC timestamp when the execution started.
+"endTimestamp": A formatted UTC timestamp when the execution ended.
+"descriptionKey": A string that describes what is being executed.
+"status": "SUCCESS" or "FAILURE"
+```
+
##Unrecognized Paths
For those detectors that support it (currently, only CLANG), a list of file paths to dependencies that
(a) were not recognized by the package manager, and (b) reside outside the source directory.
````
{
- "
- <Detector type>": [ A list of file paths to unrecognized dependencies ]
+"<Detector type>": [ A list of file paths to unrecognized dependencies ]
}
````
