arno/clair
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

api/v1: indexed layers for notifications

Browse Source 
This change deprecates the old LayersIntroducingVulnerability for a new
one that orders output and contains an Index. This index is not
guaranteed to be consistent across multiple notifications, despite the
current Postgres implementation using the primary key of Layer table.
This commit is contained in:
Jimmy Zelinskie 2016-12-06 18:42:43 -05:00
parent 1fcae6abb8
commit d4522e9c6e
3 changed files with 51 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Documentation/api_v1.md
View File

@ -556,7 +556,8 @@ Server: clair
#### Description #### Description
The GET route for the Notifications resource displays a notification that a Vulnerability has been updated. The GET route for the Notifications resource displays a notification that a Vulnerability has been updated.
This route supports simultaneous pagination for both the `Old` and `New` Vulnerabilities' `LayersIntroducingVulnerability` property which can be extremely long. This route supports simultaneous pagination for both the `Old` and `New` Vulnerabilities' `OrderedLayersIntroducingVulnerability` which can be extremely long.
The `LayersIntroducingVulnerability` property is deprecated and will eventually be removed from the API.
#### Query Parameters #### Query Parameters
@ -573,11 +574,13 @@ GET http://localhost:6060/v1/notifications/ec45ec87-bfc8-4129-a1c3-d2b82622175a?
#### Example Response #### Example Response
```json ```http
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8 Content-Type: application/json;charset=utf-8
Server: clair Server: clair
```
```json
{ {
"Notification": { "Notification": {
"Name": "ec45ec87-bfc8-4129-a1c3-d2b82622175a", "Name": "ec45ec87-bfc8-4129-a1c3-d2b82622175a",
@ -600,9 +603,19 @@ Server: clair
} }
] ]
}, },
"OrderedLayersIntroducingVulnerability": [
{
"Index": 1,
"LayerName": "523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6"
},
{
"Index": 2,
"LayerName": "3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d3f4be1916b12d"
}
],
"LayersIntroducingVulnerability": [ "LayersIntroducingVulnerability": [
"3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d3f4be1916b12d.9673fdf7-b81a-4b3e-acf8-e551ef155449", "523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6",
"523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6" "3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d182371916b12d"
] ]
}, },
"Old": { "Old": {
@ -613,8 +626,18 @@ Server: clair
"Severity": "Low", "Severity": "Low",
"FixedIn": [] "FixedIn": []
}, },
"OrderedLayersIntroducingVulnerability": [
{
"Index": 1,
"LayerName": "523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6"
},
{
"Index": 2,
"LayerName": "3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d3f4be1916b12d"
}
],
"LayersIntroducingVulnerability": [ "LayersIntroducingVulnerability": [
"3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d3f4be1916b12d.9673fdf7-b81a-4b3e-acf8-e551ef155449", "3b59c795b34670618fbcace4dac7a27c5ecec156812c9e2c90d3f4be1916b12d",
"523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6" "523ef1d23f222195488575f52a39c729c76a8c5630c9a194139cb246fb212da6"
] ]
} }

25
api/v1/models.go
View File

@ -251,21 +251,38 @@ func NotificationFromDatabaseModel(dbNotification database.VulnerabilityNotifica
} }
type VulnerabilityWithLayers struct { type VulnerabilityWithLayers struct {
Vulnerability *Vulnerability `json:"Vulnerability,omitempty"` Vulnerability *Vulnerability `json:"Vulnerability,omitempty"`
LayersIntroducingVulnerability []string `json:"LayersIntroducingVulnerability,omitempty"`
// This field is guaranteed to be in order only for pagination.
// Indices from different notifications may not be comparable.
OrderedLayersIntroducingVulnerability []OrderedLayerName `json:"OrderedLayersIntroducingVulnerability,omitempty"`
// This field is deprecated.
LayersIntroducingVulnerability []string `json:"LayersIntroducingVulnerability,omitempty"`
}
type OrderedLayerName struct {
Index int `json:"Index"`
LayerName string `json:"LayerName"`
} }
func VulnerabilityWithLayersFromDatabaseModel(dbVuln database.Vulnerability) VulnerabilityWithLayers { func VulnerabilityWithLayersFromDatabaseModel(dbVuln database.Vulnerability) VulnerabilityWithLayers {
vuln := VulnerabilityFromDatabaseModel(dbVuln, true) vuln := VulnerabilityFromDatabaseModel(dbVuln, true)
var layers []string var layers []string
var orderedLayers []OrderedLayerName
for _, layer := range dbVuln.LayersIntroducingVulnerability { for _, layer := range dbVuln.LayersIntroducingVulnerability {
layers = append(layers, layer.Name) layers = append(layers, layer.Name)
orderedLayers = append(orderedLayers, OrderedLayerName{
Index: layer.ID,
LayerName: layer.Name,
})
} }
return VulnerabilityWithLayers{ return VulnerabilityWithLayers{
Vulnerability: &vuln, Vulnerability: &vuln,
LayersIntroducingVulnerability: layers, OrderedLayersIntroducingVulnerability: orderedLayers,
LayersIntroducingVulnerability: layers,
} }
} }