Skip to content

Commit

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

The following keys were added:
- schemas.BuildStep.description
- schemas.BuildStep.id
- schemas.BuildStep.properties.args.description
- schemas.BuildStep.properties.args.items.type
- schemas.BuildStep.properties.args.type
- schemas.BuildStep.properties.dir.description
- schemas.BuildStep.properties.dir.type
- schemas.BuildStep.properties.entrypoint.description
- schemas.BuildStep.properties.entrypoint.type
- schemas.BuildStep.properties.env.description
- schemas.BuildStep.properties.env.items.type
- schemas.BuildStep.properties.env.type
- schemas.BuildStep.properties.id.description
- schemas.BuildStep.properties.id.type
- schemas.BuildStep.properties.name.description
- schemas.BuildStep.properties.name.type
- schemas.BuildStep.properties.pullTiming.$ref
- schemas.BuildStep.properties.pullTiming.description
- schemas.BuildStep.properties.pullTiming.readOnly
- schemas.BuildStep.properties.script.description
- schemas.BuildStep.properties.script.type
- schemas.BuildStep.properties.secretEnv.description
- schemas.BuildStep.properties.secretEnv.items.type
- schemas.BuildStep.properties.secretEnv.type
- schemas.BuildStep.properties.status.description
- schemas.BuildStep.properties.status.enum
- schemas.BuildStep.properties.status.enumDescriptions
- schemas.BuildStep.properties.status.readOnly
- schemas.BuildStep.properties.status.type
- schemas.BuildStep.properties.timeout.description
- schemas.BuildStep.properties.timeout.format
- schemas.BuildStep.properties.timeout.type
- schemas.BuildStep.properties.timing.$ref
- schemas.BuildStep.properties.timing.description
- schemas.BuildStep.properties.timing.readOnly
- schemas.BuildStep.properties.volumes.description
- schemas.BuildStep.properties.volumes.items.$ref
- schemas.BuildStep.properties.volumes.type
- schemas.BuildStep.properties.waitFor.description
- schemas.BuildStep.properties.waitFor.items.type
- schemas.BuildStep.properties.waitFor.type
- schemas.BuildStep.type
- schemas.TimeSpan.description
- schemas.TimeSpan.id
- schemas.TimeSpan.properties.endTime.description
- schemas.TimeSpan.properties.endTime.format
- schemas.TimeSpan.properties.endTime.type
- schemas.TimeSpan.properties.startTime.description
- schemas.TimeSpan.properties.startTime.format
- schemas.TimeSpan.properties.startTime.type
- schemas.TimeSpan.type
- schemas.Volume.description
- schemas.Volume.id
- schemas.Volume.properties.name.description
- schemas.Volume.properties.name.type
- schemas.Volume.properties.path.description
- schemas.Volume.properties.path.type
- schemas.Volume.type

#### containeranalysis:v1beta1

The following keys were added:
- schemas.BuildStep.description
- schemas.BuildStep.id
- schemas.BuildStep.properties.args.description
- schemas.BuildStep.properties.args.items.type
- schemas.BuildStep.properties.args.type
- schemas.BuildStep.properties.dir.description
- schemas.BuildStep.properties.dir.type
- schemas.BuildStep.properties.entrypoint.description
- schemas.BuildStep.properties.entrypoint.type
- schemas.BuildStep.properties.env.description
- schemas.BuildStep.properties.env.items.type
- schemas.BuildStep.properties.env.type
- schemas.BuildStep.properties.id.description
- schemas.BuildStep.properties.id.type
- schemas.BuildStep.properties.name.description
- schemas.BuildStep.properties.name.type
- schemas.BuildStep.properties.pullTiming.$ref
- schemas.BuildStep.properties.pullTiming.description
- schemas.BuildStep.properties.pullTiming.readOnly
- schemas.BuildStep.properties.script.description
- schemas.BuildStep.properties.script.type
- schemas.BuildStep.properties.secretEnv.description
- schemas.BuildStep.properties.secretEnv.items.type
- schemas.BuildStep.properties.secretEnv.type
- schemas.BuildStep.properties.status.description
- schemas.BuildStep.properties.status.enum
- schemas.BuildStep.properties.status.enumDescriptions
- schemas.BuildStep.properties.status.readOnly
- schemas.BuildStep.properties.status.type
- schemas.BuildStep.properties.timeout.description
- schemas.BuildStep.properties.timeout.format
- schemas.BuildStep.properties.timeout.type
- schemas.BuildStep.properties.timing.$ref
- schemas.BuildStep.properties.timing.description
- schemas.BuildStep.properties.timing.readOnly
- schemas.BuildStep.properties.volumes.description
- schemas.BuildStep.properties.volumes.items.$ref
- schemas.BuildStep.properties.volumes.type
- schemas.BuildStep.properties.waitFor.description
- schemas.BuildStep.properties.waitFor.items.type
- schemas.BuildStep.properties.waitFor.type
- schemas.BuildStep.type
- schemas.TimeSpan.description
- schemas.TimeSpan.id
- schemas.TimeSpan.properties.endTime.description
- schemas.TimeSpan.properties.endTime.format
- schemas.TimeSpan.properties.endTime.type
- schemas.TimeSpan.properties.startTime.description
- schemas.TimeSpan.properties.startTime.format
- schemas.TimeSpan.properties.startTime.type
- schemas.TimeSpan.type
- schemas.Volume.description
- schemas.Volume.id
- schemas.Volume.properties.name.description
- schemas.Volume.properties.name.type
- schemas.Volume.properties.path.description
- schemas.Volume.properties.path.type
- schemas.Volume.type
  • Loading branch information
@yoshi-automation @sofisl
yoshi-automation authored and sofisl committed Sep 23, 2021
1 parent 0d5c5a4 commit afcff68
Show file tree
Hide file tree
Showing 4 changed files with 452 additions and 2 deletions.
140 changes: 139 additions & 1 deletion discovery/containeranalysis-v1alpha1.json
View file
Expand Up @@ -1229,7 +1229,7 @@
}
}
},
"revision": "20210825",
"revision": "20210913",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"Artifact": {
Expand Down Expand Up @@ -1449,6 +1449,112 @@
},
"type": "object"
},
"BuildStep": {
"description": "A step in the build pipeline.",
"id": "BuildStep",
"properties": {
"args": {
"description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"dir": {
"description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.",
"type": "string"
},
"entrypoint": {
"description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.",
"type": "string"
},
"env": {
"description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.",
"type": "string"
},
"name": {
"description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.",
"type": "string"
},
"pullTiming": {
"$ref": "TimeSpan",
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
"readOnly": true
},
"script": {
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
"type": "string"
},
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
"FAILURE",
"INTERNAL_ERROR",
"TIMEOUT",
"CANCELLED",
"EXPIRED"
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
"Build or step failed to complete successfully.",
"Build or step failed due to an internal cause.",
"Build or step took longer than was allowed.",
"Build or step was canceled by a user.",
"Build was enqueued for longer than the value of `queue_ttl`."
],
"readOnly": true,
"type": "string"
},
"timeout": {
"description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.",
"format": "google-duration",
"type": "string"
},
"timing": {
"$ref": "TimeSpan",
"description": "Output only. Stores timing information for executing this build step.",
"readOnly": true
},
"volumes": {
"description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.",
"items": {
"$ref": "Volume"
},
"type": "array"
},
"waitFor": {
"description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BuildType": {
"description": "Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails.",
"id": "BuildType",
Expand Down Expand Up @@ -3705,6 +3811,23 @@
},
"type": "object"
},
"TimeSpan": {
"description": "Start and end times for a build execution phase.",
"id": "TimeSpan",
"properties": {
"endTime": {
"description": "End of time span.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start of time span.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdateOperationRequest": {
"description": "Request for updating an existing operation",
"id": "UpdateOperationRequest",
Expand Down Expand Up @@ -3826,6 +3949,21 @@
},
"type": "object"
},
"Volume": {
"description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.",
"id": "Volume",
"properties": {
"name": {
"description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.",
"type": "string"
},
"path": {
"description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityDetails": {
"description": "Used by Occurrence to point to where the vulnerability exists and how to fix it.",
"id": "VulnerabilityDetails",
Expand Down
140 changes: 139 additions & 1 deletion discovery/containeranalysis-v1beta1.json
View file
Expand Up @@ -853,7 +853,7 @@
}
}
},
"revision": "20210820",
"revision": "20210913",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
Expand Down Expand Up @@ -1166,6 +1166,112 @@
},
"type": "object"
},
"BuildStep": {
"description": "A step in the build pipeline.",
"id": "BuildStep",
"properties": {
"args": {
"description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"dir": {
"description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.",
"type": "string"
},
"entrypoint": {
"description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.",
"type": "string"
},
"env": {
"description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.",
"type": "string"
},
"name": {
"description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.",
"type": "string"
},
"pullTiming": {
"$ref": "TimeSpan",
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
"readOnly": true
},
"script": {
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
"type": "string"
},
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
"FAILURE",
"INTERNAL_ERROR",
"TIMEOUT",
"CANCELLED",
"EXPIRED"
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
"Build or step failed to complete successfully.",
"Build or step failed due to an internal cause.",
"Build or step took longer than was allowed.",
"Build or step was canceled by a user.",
"Build was enqueued for longer than the value of `queue_ttl`."
],
"readOnly": true,
"type": "string"
},
"timeout": {
"description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.",
"format": "google-duration",
"type": "string"
},
"timing": {
"$ref": "TimeSpan",
"description": "Output only. Stores timing information for executing this build step.",
"readOnly": true
},
"volumes": {
"description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.",
"items": {
"$ref": "Volume"
},
"type": "array"
},
"waitFor": {
"description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ByProducts": {
"description": "Defines an object for the byproducts field in in-toto links. The suggested fields are \"stderr\", \"stdout\", and \"return-value\".",
"id": "ByProducts",
Expand Down Expand Up @@ -3403,6 +3509,23 @@
},
"type": "object"
},
"TimeSpan": {
"description": "Start and end times for a build execution phase.",
"id": "TimeSpan",
"properties": {
"endTime": {
"description": "End of time span.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start of time span.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Version": {
"description": "Version contains structured information about the version of a package.",
"id": "Version",
Expand Down Expand Up @@ -3443,6 +3566,21 @@
},
"type": "object"
},
"Volume": {
"description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.",
"id": "Volume",
"properties": {
"name": {
"description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.",
"type": "string"
},
"path": {
"description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.",
"type": "string"
}
},
"type": "object"
},
"Vulnerability": {
"description": "Vulnerability provides metadata about a security vulnerability in a Note.",
"id": "Vulnerability",
Expand Down

0 comments on commit afcff68

Please sign in to comment.