Skip to content

Commit 9225ac7

Browse files
feat(ondemandscanning): update the api
#### ondemandscanning:v1 The following keys were deleted: - schemas.Binary (Total Keys: 4) - schemas.PackageData.properties.binary.$ref (Total Keys: 1) The following keys were added: - schemas.Occurrence.properties.sbomReference.$ref (Total Keys: 1) - schemas.PackageData.properties.binaryVersion.$ref (Total Keys: 1) - schemas.PackageData.properties.sourceVersion.$ref (Total Keys: 1) - schemas.PackageVersion (Total Keys: 4) - schemas.SBOMReferenceOccurrence (Total Keys: 6) - schemas.SbomReferenceIntotoPayload (Total Keys: 7) - schemas.SbomReferenceIntotoPredicate (Total Keys: 7) #### ondemandscanning:v1beta1 The following keys were deleted: - schemas.Binary (Total Keys: 4) - schemas.PackageData.properties.binary.$ref (Total Keys: 1) The following keys were added: - schemas.Occurrence.properties.sbomReference.$ref (Total Keys: 1) - schemas.PackageData.properties.binaryVersion.$ref (Total Keys: 1) - schemas.PackageData.properties.sourceVersion.$ref (Total Keys: 1) - schemas.PackageVersion (Total Keys: 4) - schemas.SBOMReferenceOccurrence (Total Keys: 6) - schemas.SbomReferenceIntotoPayload (Total Keys: 7) - schemas.SbomReferenceIntotoPredicate (Total Keys: 7)
1 parent c1311fc commit 9225ac7

6 files changed

+306
-44
lines changed

docs/dyn/ondemandscanning_v1.projects.locations.scans.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>Method Details</h3>
100100
&quot;packages&quot;: [ # The packages to analyze.
101101
{
102102
&quot;architecture&quot;: &quot;A String&quot;, # The architecture of the package.
103-
&quot;binary&quot;: { # The binary package. This is significant when the source is different than the binary itself. Historically if they&#x27;ve differed, we&#x27;ve stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that&#x27;s what&#x27;s actually installed. See b/175908657#comment15.
103+
&quot;binaryVersion&quot;: { # The binary package. This is significant when the source is different than the binary itself. Historically if they&#x27;ve differed, we&#x27;ve stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that&#x27;s what&#x27;s actually installed. See b/175908657#comment15.
104104
&quot;name&quot;: &quot;A String&quot;,
105105
&quot;version&quot;: &quot;A String&quot;,
106106
},
@@ -128,6 +128,10 @@ <h3>Method Details</h3>
128128
&quot;patchedCve&quot;: [ # CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning
129129
&quot;A String&quot;,
130130
],
131+
&quot;sourceVersion&quot;: { # The source package. Similar to the above, this is significant when the source is different than the binary itself. Since the top-level package/version fields are based on an if/else, we need a separate field for both binary and source if we want to know definitively where the data is coming from.
132+
&quot;name&quot;: &quot;A String&quot;,
133+
&quot;version&quot;: &quot;A String&quot;,
134+
},
131135
&quot;unused&quot;: &quot;A String&quot;,
132136
&quot;version&quot;: &quot;A String&quot;, # The version of the package being analysed
133137
},

docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,35 @@ <h3>Method Details</h3>
656656
},
657657
&quot;remediation&quot;: &quot;A String&quot;, # A description of actions that can be taken to remedy the note.
658658
&quot;resourceUri&quot;: &quot;A String&quot;, # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
659+
&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. # Describes a specific SBOM reference occurrences.
660+
&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.
661+
&quot;_type&quot;: &quot;A String&quot;, # Identifier for the schema of the Statement.
662+
&quot;predicate&quot;: { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
663+
&quot;digest&quot;: { # A map of algorithm to digest of the contents of the SBOM.
664+
&quot;a_key&quot;: &quot;A String&quot;,
665+
},
666+
&quot;location&quot;: &quot;A String&quot;, # The location of the SBOM.
667+
&quot;mimeType&quot;: &quot;A String&quot;, # The mime type of the SBOM.
668+
&quot;referrerId&quot;: &quot;A String&quot;, # The person or system referring this predicate to the consumer.
669+
},
670+
&quot;predicateType&quot;: &quot;A String&quot;, # URI identifying the type of the Predicate.
671+
&quot;subject&quot;: [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
672+
{
673+
&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
674+
&quot;a_key&quot;: &quot;A String&quot;,
675+
},
676+
&quot;name&quot;: &quot;A String&quot;,
677+
},
678+
],
679+
},
680+
&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;.
681+
&quot;signatures&quot;: [ # The signatures over the payload.
682+
{
683+
&quot;keyid&quot;: &quot;A String&quot;,
684+
&quot;sig&quot;: &quot;A String&quot;,
685+
},
686+
],
687+
},
659688
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this occurrence was last updated.
660689
&quot;upgrade&quot;: { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
661690
&quot;distribution&quot;: { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>Method Details</h3>
9999
&quot;packages&quot;: [ # The packages to analyze.
100100
{
101101
&quot;architecture&quot;: &quot;A String&quot;, # The architecture of the package.
102-
&quot;binary&quot;: { # The binary package. This is significant when the source is different than the binary itself. Historically if they&#x27;ve differed, we&#x27;ve stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that&#x27;s what&#x27;s actually installed. See b/175908657#comment15.
102+
&quot;binaryVersion&quot;: { # The binary package. This is significant when the source is different than the binary itself. Historically if they&#x27;ve differed, we&#x27;ve stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that&#x27;s what&#x27;s actually installed. See b/175908657#comment15.
103103
&quot;name&quot;: &quot;A String&quot;,
104104
&quot;version&quot;: &quot;A String&quot;,
105105
},
@@ -127,6 +127,10 @@ <h3>Method Details</h3>
127127
&quot;patchedCve&quot;: [ # CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning
128128
&quot;A String&quot;,
129129
],
130+
&quot;sourceVersion&quot;: { # The source package. Similar to the above, this is significant when the source is different than the binary itself. Since the top-level package/version fields are based on an if/else, we need a separate field for both binary and source if we want to know definitively where the data is coming from.
131+
&quot;name&quot;: &quot;A String&quot;,
132+
&quot;version&quot;: &quot;A String&quot;,
133+
},
130134
&quot;unused&quot;: &quot;A String&quot;,
131135
&quot;version&quot;: &quot;A String&quot;, # The version of the package being analysed
132136
},

docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,35 @@ <h3>Method Details</h3>
656656
},
657657
&quot;remediation&quot;: &quot;A String&quot;, # A description of actions that can be taken to remedy the note.
658658
&quot;resourceUri&quot;: &quot;A String&quot;, # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
659+
&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. # Describes a specific SBOM reference occurrences.
660+
&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.
661+
&quot;_type&quot;: &quot;A String&quot;, # Identifier for the schema of the Statement.
662+
&quot;predicate&quot;: { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
663+
&quot;digest&quot;: { # A map of algorithm to digest of the contents of the SBOM.
664+
&quot;a_key&quot;: &quot;A String&quot;,
665+
},
666+
&quot;location&quot;: &quot;A String&quot;, # The location of the SBOM.
667+
&quot;mimeType&quot;: &quot;A String&quot;, # The mime type of the SBOM.
668+
&quot;referrerId&quot;: &quot;A String&quot;, # The person or system referring this predicate to the consumer.
669+
},
670+
&quot;predicateType&quot;: &quot;A String&quot;, # URI identifying the type of the Predicate.
671+
&quot;subject&quot;: [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
672+
{
673+
&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
674+
&quot;a_key&quot;: &quot;A String&quot;,
675+
},
676+
&quot;name&quot;: &quot;A String&quot;,
677+
},
678+
],
679+
},
680+
&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;.
681+
&quot;signatures&quot;: [ # The signatures over the payload.
682+
{
683+
&quot;keyid&quot;: &quot;A String&quot;,
684+
&quot;sig&quot;: &quot;A String&quot;,
685+
},
686+
],
687+
},
659688
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this occurrence was last updated.
660689
&quot;upgrade&quot;: { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
661690
&quot;distribution&quot;: { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

0 commit comments

Comments
 (0)