Skip to content

Commit

Permalink
feat(containeranalysis): update the api
Browse files Browse the repository at this point in the history
#### containeranalysis:v1

The following keys were added:
- resources.projects.resources.resources.methods.exportSBOM (Total Keys: 12)
- schemas.CloudStorageLocation (Total Keys: 2)
- schemas.ExportSBOMRequest (Total Keys: 3)
- schemas.ExportSBOMResponse (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Feb 27, 2024
1 parent 16f693e commit 5ee6796
Show file tree
Hide file tree
Showing 12 changed files with 102 additions and 41 deletions.
5 changes: 5 additions & 0 deletions docs/dyn/containeranalysis_v1.projects.html
Expand Up @@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the occurrences Resource.</p>

<p class="toc_element">
<code><a href="containeranalysis_v1.projects.resources.html">resources()</a></code>
</p>
<p class="firstline">Returns the resources Resource.</p>

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1.projects.notes.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1.projects.occurrences.html

Large diffs are not rendered by default.

24 changes: 10 additions & 14 deletions docs/dyn/containeranalysis_v1.projects.resources.html
Expand Up @@ -78,24 +78,26 @@ <h2>Instance Methods</h2>
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a summary of the packages within a given resource.</p>
<code><a href="#exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates an SBOM for the given resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</code>
<pre>Gets a summary of the packages within a given resource.
<code class="details" id="exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</code>
<pre>Generates an SBOM for the given resource.

Args:
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)
name: string, Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. (required)
body: object, The request body.
The object takes the form of:

{ # GeneratePackagesSummaryRequest is the request body for the GeneratePackagesSummary API method. It just takes a single name argument, referring to the resource.
{ # The request to generate and export SBOM. Target must be specified for the request.
&quot;cloudStorageLocation&quot;: { # Empty placeholder to denote that this is a Google Cloud Storage export request. # Empty placeholder to denote that this is a Google Cloud Storage export request.
},
}

x__xgafv: string, V1 error format.
Expand All @@ -106,14 +108,8 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # A summary of the packages found within the given resource.
&quot;licensesSummary&quot;: [ # A listing by license name of each of the licenses and their counts.
{ # Per license count
&quot;count&quot;: &quot;A String&quot;, # The number of fixable vulnerabilities associated with this resource.
&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...
},
],
&quot;resourceUrl&quot;: &quot;A String&quot;, # The unique URL of the image or the container for which this summary applies.
{ # The response from a call to ExportSBOM.
&quot;discoveryOccurrence&quot;: &quot;A String&quot;, # The name of the discovery occurrence in the form &quot;projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to track the progress of the SBOM export.
}</pre>
</div>

Expand Down
6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1alpha1.projects.notes.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1alpha1.providers.notes.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1beta1.projects.notes.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/dyn/containeranalysis_v1beta1.projects.occurrences.html

Large diffs are not rendered by default.

Expand Up @@ -751,11 +751,43 @@
]
}
}
},
"resources": {
"methods": {
"exportSBOM": {
"description": "Generates an SBOM for the given resource.",
"flatPath": "v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM",
"httpMethod": "POST",
"id": "containeranalysis.projects.resources.exportSBOM",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.",
"location": "path",
"pattern": "^projects/[^/]+/resources/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:exportSBOM",
"request": {
"$ref": "ExportSBOMRequest"
},
"response": {
"$ref": "ExportSBOMResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20240105",
"revision": "20240220",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
Expand Down Expand Up @@ -996,7 +1028,7 @@
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
Expand Down Expand Up @@ -1659,6 +1691,12 @@
},
"type": "object"
},
"CloudStorageLocation": {
"description": "Empty placeholder to denote that this is a Google Cloud Storage export request.",
"id": "CloudStorageLocation",
"properties": {},
"type": "object"
},
"Command": {
"description": "Command describes a step performed as part of the build pipeline.",
"id": "Command",
Expand Down Expand Up @@ -3421,6 +3459,28 @@ false
},
"type": "object"
},
"ExportSBOMRequest": {
"description": "The request to generate and export SBOM. Target must be specified for the request.",
"id": "ExportSBOMRequest",
"properties": {
"cloudStorageLocation": {
"$ref": "CloudStorageLocation",
"description": "Empty placeholder to denote that this is a Google Cloud Storage export request."
}
},
"type": "object"
},
"ExportSBOMResponse": {
"description": "The response from a call to ExportSBOM.",
"id": "ExportSBOMResponse",
"properties": {
"discoveryOccurrence": {
"description": "The name of the discovery occurrence in the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to track the progress of the SBOM export.",
"type": "string"
}
},
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "Expr",
Expand Down
Expand Up @@ -1233,7 +1233,7 @@
}
}
},
"revision": "20240105",
"revision": "20240220",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AnalysisCompleted": {
Expand Down Expand Up @@ -1405,7 +1405,7 @@
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
Expand Down
Expand Up @@ -815,7 +815,7 @@
}
}
},
"revision": "20240105",
"revision": "20240220",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
Expand Down Expand Up @@ -1082,7 +1082,7 @@
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
Expand Down

0 comments on commit 5ee6796

Please sign in to comment.