api/v1: indexed layers for notifications #282
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jzelinskie
added
area/usability
jzelinskie
commented
Dec 7, 2016
| @@ -108,7 +108,7 @@ Server: clair | |||
|
|
|||
| #### Description | |||
|
|
|||
| The GET route for the Layers resource displays a Layer and optionally all of its features and vulnerabilities. For an image composed of three layers A->B->C, calling this route on the third layer (C) will returns all the features and vulnerabilities for the entire image, including the analysis data gathered from the parent layers (A, B). For instance, a feature (and its potential vulnerabilities) detected in the first layer (A) will be shown when querying the third layer (C). On the other hand, a feature detected in the first layer (A) but then removed in either following layers (B, C) will not appear. | |||
| The GET route for the Layers resource displays a Layer and optionally all of its features and vulnerabilities. For an image composed of three layers A->B->C, calling this route on the third layer (C) will returns all the features and vulnerabilities for the entire image, including the analysis data gathered from the parent layers (A, B). For instance, a feature (and its potential vulnerabilities) detected in the first layer (A) will be shown when querying the third layer (C). On the other hand, a feature detected in the first layer (A) but then removed in either following layers (B, C) will not appear. | |||
There was a problem hiding this comment.
I have no idea what changed here.
There was a problem hiding this comment.
I spent few minutes trying to figure it out too.
Quentin-M
reviewed
Dec 7, 2016
| Vulnerability *Vulnerability `json:"Vulnerability,omitempty"` | ||
|
|
||
| // This field is guaranteed to be in order only for pagination. | ||
| // Indices from different notifications cannot be compared. |
Quentin-M
reviewed
Dec 7, 2016
| LayersIntroducingVulnerability []string `json:"LayersIntroducingVulnerability,omitempty"` | ||
| } | ||
|
|
||
| type OrderedLayer struct { |
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.
|
It can be tremendously useful for streaming diff between the lists across multiple pages. few nits then LGTM. Hopefully the field won't stay too long here because it literally doubles the size of that already long response. |
Quentin-M
approved these changes
Dec 7, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.