Skip to content

Commit b76402b

Browse files
committed
docs(vulnerable-code): Add links to upstream meta data classes
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 275226b commit b76402b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

clients/vulnerable-code/src/main/kotlin/VulnerableCodeService.kt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ interface VulnerableCodeService {
8181
/**
8282
* Data class that represents a score assigned to a vulnerability. A source of vulnerability information can
8383
* provide multiple score values using different scoring systems.
84+
*
85+
* See https://github.com/aboutcode-org/vulnerablecode/blob/v36.1.3/vulnerabilities/api.py#L42-L44.
8486
*/
8587
@Serializable
8688
data class Score(
@@ -100,6 +102,8 @@ interface VulnerableCodeService {
100102
/**
101103
* Data class representing a reference to detailed information about a vulnerability. Information about a single
102104
* vulnerability can come from multiple sources; for each of these sources a reference is added to the data.
105+
*
106+
* See https://github.com/aboutcode-org/vulnerablecode/blob/v36.1.3/vulnerabilities/api.py#L58-L60.
103107
*/
104108
@Serializable
105109
data class VulnerabilityReference(
@@ -117,6 +121,8 @@ interface VulnerableCodeService {
117121

118122
/**
119123
* Data class representing a single vulnerability with its references to detailed information.
124+
*
125+
* See https://github.com/aboutcode-org/vulnerablecode/blob/v36.1.3/vulnerabilities/api.py#L176-L188.
120126
*/
121127
@Serializable
122128
data class Vulnerability(
@@ -138,6 +144,8 @@ interface VulnerableCodeService {
138144
/**
139145
* Data class describing a package in the result of a package query together with the vulnerabilities known for
140146
* this package.
147+
*
148+
* See https://github.com/aboutcode-org/vulnerablecode/blob/v36.1.3/vulnerabilities/api.py#L396-L413.
141149
*/
142150
@Serializable
143151
data class PackageVulnerabilities(

0 commit comments

Comments
 (0)