Skip to content

Commit c0ea5ab

Browse files
feat(containeranalysis): update the api
#### containeranalysis:v1 The following keys were added: - resources.projects.resources.resources.methods.generatePackagesSummary (Total Keys: 12) - schemas.Assessment (Total Keys: 11) - schemas.GeneratePackagesSummaryRequest (Total Keys: 2) - schemas.Justification (Total Keys: 4) - schemas.LicensesSummary (Total Keys: 5) - schemas.Note.properties.vulnerabilityAssessment.$ref (Total Keys: 1) - schemas.PackagesSummaryResponse (Total Keys: 4) - schemas.Product (Total Keys: 5) - schemas.Publisher (Total Keys: 5) - schemas.Remediation (Total Keys: 5) - schemas.VexAssessment (Total Keys: 12) - schemas.VulnerabilityAssessmentNote (Total Keys: 6) - schemas.VulnerabilityOccurrence.properties.vexAssessment.$ref (Total Keys: 1) #### containeranalysis:v1alpha1 The following keys were added: - schemas.Note.properties.sbomReference.$ref (Total Keys: 1) - schemas.Occurrence.properties.sbomReference.$ref (Total Keys: 1) - schemas.SBOMReferenceNote (Total Keys: 4) - schemas.SBOMReferenceOccurrence (Total Keys: 6) - schemas.SbomReferenceIntotoPayload (Total Keys: 7) - schemas.SbomReferenceIntotoPredicate (Total Keys: 7) #### containeranalysis:v1beta1 The following keys were added: - schemas.Note.properties.sbomReference.$ref (Total Keys: 1) - schemas.Occurrence.properties.sbomReference.$ref (Total Keys: 1) - schemas.SBOMReferenceNote (Total Keys: 4) - schemas.SBOMReferenceOccurrence (Total Keys: 6) - schemas.SbomReferenceIntotoPayload (Total Keys: 7) - schemas.SbomReferenceIntotoPredicate (Total Keys: 7) - schemas.Subject (Total Keys: 5)
1 parent bc858fd commit c0ea5ab

16 files changed

+1957
-23
lines changed

docs/dyn/containeranalysis_v1.projects.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
8484
</p>
8585
<p class="firstline">Returns the occurrences Resource.</p>
8686

87+
<p class="toc_element">
88+
<code><a href="containeranalysis_v1.projects.resources.html">resources()</a></code>
89+
</p>
90+
<p class="firstline">Returns the resources Resource.</p>
91+
8792
<p class="toc_element">
8893
<code><a href="#close">close()</a></code></p>
8994
<p class="firstline">Close httplib2 connections.</p>

docs/dyn/containeranalysis_v1.projects.notes.html

Lines changed: 360 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/containeranalysis_v1.projects.notes.occurrences.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -771,6 +771,34 @@ <h3>Method Details</h3>
771771
&quot;severity&quot;: &quot;A String&quot;, # Output only. The note provider assigned severity of this vulnerability.
772772
&quot;shortDescription&quot;: &quot;A String&quot;, # Output only. A one sentence description of this vulnerability.
773773
&quot;type&quot;: &quot;A String&quot;, # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
774+
&quot;vexAssessment&quot;: { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
775+
&quot;cve&quot;: &quot;A String&quot;, # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability.
776+
&quot;impacts&quot;: [ # Contains information about the impact of this vulnerability, this will change with time.
777+
&quot;A String&quot;,
778+
],
779+
&quot;justification&quot;: { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
780+
&quot;details&quot;: &quot;A String&quot;, # Additional details on why this justification was chosen.
781+
&quot;justificationType&quot;: &quot;A String&quot;, # The justification type for this vulnerability.
782+
},
783+
&quot;noteName&quot;: &quot;A String&quot;, # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
784+
&quot;relatedUris&quot;: [ # Holds a list of references associated with this vulnerability item and assessment.
785+
{ # Metadata for any related URL information.
786+
&quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL.
787+
&quot;url&quot;: &quot;A String&quot;, # Specific URL associated with the resource.
788+
},
789+
],
790+
&quot;remediations&quot;: [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
791+
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
792+
&quot;details&quot;: &quot;A String&quot;, # Contains a comprehensive human-readable discussion of the remediation.
793+
&quot;remediationType&quot;: &quot;A String&quot;, # The type of remediation that can be applied.
794+
&quot;remediationUri&quot;: { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
795+
&quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL.
796+
&quot;url&quot;: &quot;A String&quot;, # Specific URL associated with the resource.
797+
},
798+
},
799+
],
800+
&quot;state&quot;: &quot;A String&quot;, # Provides the state of this Vulnerability assessment.
801+
},
774802
},
775803
},
776804
],

docs/dyn/containeranalysis_v1.projects.occurrences.html

Lines changed: 269 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="containeranalysis_v1.html">Container Analysis API</a> . <a href="containeranalysis_v1.projects.html">projects</a> . <a href="containeranalysis_v1.projects.resources.html">resources</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Gets a summary of the packages within a given resource.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="close">close()</code>
86+
<pre>Close httplib2 connections.</pre>
87+
</div>
88+
89+
<div class="method">
90+
<code class="details" id="generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</code>
91+
<pre>Gets a summary of the packages within a given resource.
92+
93+
Args:
94+
name: string, Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. (required)
95+
body: object, The request body.
96+
The object takes the form of:
97+
98+
{ # GeneratePackagesSummaryRequest is the request body for the GeneratePackagesSummary API method. It just takes a single name argument, referring to the resource.
99+
}
100+
101+
x__xgafv: string, V1 error format.
102+
Allowed values
103+
1 - v1 error format
104+
2 - v2 error format
105+
106+
Returns:
107+
An object of the form:
108+
109+
{ # A summary of the packages found within the given resource.
110+
&quot;licensesSummary&quot;: [ # A listing by license name of each of the licenses and their counts.
111+
{ # Per license count
112+
&quot;count&quot;: &quot;A String&quot;, # The number of fixable vulnerabilities associated with this resource.
113+
&quot;license&quot;: &quot;A String&quot;, # The license of the package. Note that the format of this value is not guaranteed. It may be nil, an empty string, a boolean value (A | B), a differently formed boolean value (A OR B), etc...
114+
},
115+
],
116+
&quot;resourceUrl&quot;: &quot;A String&quot;, # The unique URL of the image or the container for which this summary applies.
117+
}</pre>
118+
</div>
119+
120+
</body></html>

docs/dyn/containeranalysis_v1alpha1.projects.notes.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,10 @@ <h3>Method Details</h3>
237237
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
238238
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
239239
},
240+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
241+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
242+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
243+
},
240244
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
241245
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
242246
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package
@@ -537,6 +541,10 @@ <h3>Method Details</h3>
537541
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
538542
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
539543
},
544+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
545+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
546+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
547+
},
540548
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
541549
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
542550
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package
@@ -860,6 +868,10 @@ <h3>Method Details</h3>
860868
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
861869
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
862870
},
871+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
872+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
873+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
874+
},
863875
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
864876
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
865877
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package
@@ -1215,6 +1227,10 @@ <h3>Method Details</h3>
12151227
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
12161228
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
12171229
},
1230+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
1231+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
1232+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
1233+
},
12181234
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
12191235
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
12201236
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package
@@ -1531,6 +1547,10 @@ <h3>Method Details</h3>
15311547
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
15321548
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
15331549
},
1550+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
1551+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
1552+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
1553+
},
15341554
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
15351555
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
15361556
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package
@@ -1830,6 +1850,10 @@ <h3>Method Details</h3>
18301850
&quot;dataLicence&quot;: &quot;A String&quot;, # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (&quot;SPDX-Metadata&quot;)
18311851
&quot;spdxVersion&quot;: &quot;A String&quot;, # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
18321852
},
1853+
&quot;sbomReference&quot;: { # The note representing an SBOM reference. # A note describing a reference to an SBOM.
1854+
&quot;format&quot;: &quot;A String&quot;, # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
1855+
&quot;version&quot;: &quot;A String&quot;, # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
1856+
},
18331857
&quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
18341858
&quot;spdxFile&quot;: { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
18351859
&quot;checksum&quot;: [ # Provide a unique identifier to match analysis information on each specific file in a package

docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,35 @@ <h3>Method Details</h3>
707707
&quot;namespace&quot;: &quot;A String&quot;, # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter
708708
&quot;title&quot;: &quot;A String&quot;, # Identify name of this document as designated by creator
709709
},
710+
&quot;sbomReference&quot;: { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # This represents an SBOM reference occurrence
711+
&quot;payload&quot;: { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
712+
&quot;_type&quot;: &quot;A String&quot;, # Identifier for the schema of the Statement.
713+
&quot;predicate&quot;: { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
714+
&quot;digest&quot;: { # A map of algorithm to digest of the contents of the SBOM.
715+
&quot;a_key&quot;: &quot;A String&quot;,
716+
},
717+
&quot;location&quot;: &quot;A String&quot;, # The location of the SBOM.
718+
&quot;mimeType&quot;: &quot;A String&quot;, # The mime type of the SBOM.
719+
&quot;referrerId&quot;: &quot;A String&quot;, # The person or system referring this predicate to the consumer.
720+
},
721+
&quot;predicateType&quot;: &quot;A String&quot;, # URI identifying the type of the Predicate.
722+
&quot;subject&quot;: [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
723+
{ # Subject refers to the subject of the intoto statement
724+
&quot;digest&quot;: { # &quot;&quot;: &quot;&quot; Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
725+
&quot;a_key&quot;: &quot;A String&quot;,
726+
},
727+
&quot;name&quot;: &quot;A String&quot;, # name is the name of the Subject used here
728+
},
729+
],
730+
},
731+
&quot;payloadType&quot;: &quot;A String&quot;, # The kind of payload that SbomReferenceIntotoPayload takes. Since it&#x27;s in the intoto format, this value is expected to be &#x27;application/vnd.in-toto+json&#x27;.
732+
&quot;signatures&quot;: [ # The signatures over the payload.
733+
{ # A DSSE signature
734+
&quot;keyid&quot;: &quot;A String&quot;, # A reference id to the key being used for signing
735+
&quot;sig&quot;: &quot;A String&quot;, # The signature itself
736+
},
737+
],
738+
},
710739
&quot;spdxFile&quot;: { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.
711740
&quot;attributions&quot;: [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts
712741
&quot;A String&quot;,

0 commit comments

Comments
 (0)