openapi-directory/api/googleapis.com/ondemandscanning.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://ondemandscanning.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"A service to scan container images for vulnerabilities.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"On-Demand Scanning API","version":"v1beta1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://ondemandscanning.googleapis.com/$discovery/rest?version=v1beta1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"ondemandscanning"},"externalDocs":{"url":"https://cloud.google.com/container-analysis/docs/on-demand-scanning/"},"tags":[{"name":"projects"}],"paths":{"/v1beta1/{name}":{"delete":{"description":"Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.","operationId":"ondemandscanning.projects.locations.operations.delete","parameters":[{"description":"The name of the operation resource to be deleted.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"ondemandscanning.projects.locations.operations.get","parameters":[{"description":"The name of the operation resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{name}/operations":{"get":{"description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.","operationId":"ondemandscanning.projects.locations.operations.list","parameters":[{"description":"The name of the operation's parent resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.","operationId":"ondemandscanning.projects.locations.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{name}:wait":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.","operationId":"ondemandscanning.projects.locations.operations.wait","parameters":[{"description":"The name of the operation resource to wait on.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.","in":"query","name":"timeout","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/scans:analyzePackages":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Initiates an analysis of the provided packages.","operationId":"ondemandscanning.projects.locations.scans.analyzePackages","parameters":[{"description":"Required. The parent of the resource for which analysis is requested. Format: projects/[project_name]/locations/[location]","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzePackagesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/vulnerabilities":{"get":{"description":"Lists vulnerabilities resulting from a successfully completed scan.","operationId":"ondemandscanning.projects.locations.scans.vulnerabilities.list","parameters":[{"description":"Required. The parent of the collection of Vulnerabilities being requested. Format: projects/[project_name]/locations/[location]/scans/[scan_id]","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The number of vulnerabilities to retrieve.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The page token, resulting from a previous call to ListVulnerabilities.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVulnerabilitiesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"AliasContext":{"description":"An alias to a repo revision.","properties":{"kind":{"description":"The alias kind.","enum":["KIND_UNSPECIFIED","FIXED","MOVABLE","OTHER"],"type":"string"},"name":{"description":"The alias name.","type":"string"}},"type":"object"},"AnalysisCompleted":{"description":"Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.","properties":{"analysisType":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AnalyzePackagesMetadata":{"description":"AnalyzePackagesMetadata contains metadata for an active scan of a container image.","properties":{"createTime":{"description":"When the scan was created.","format":"google-datetime","type":"string"},"resourceUri":{"description":"The resource URI of the container image being scanned.","type":"string"}},"type":"object"},"AnalyzePackagesMetadataV1":{"description":"AnalyzePackagesMetadata contains metadata for an active scan of a container image.","properties":{"createTime":{"description":"When the scan was created.","format":"google-datetime","type":"string"},"resourceUri":{"description":"The resource URI of the container image being scanned.","type":"string"}},"type":"object"},"AnalyzePackagesRequest":{"description":"AnalyzePackagesRequest is the request to analyze a list of packages and create Vulnerability Occurrences for it.","properties":{"packages":{"description":"The packages to analyze.","items":{"$ref":"#/components/schemas/PackageData"},"type":"array"},"resourceUri":{"description":"Required. The resource URI of the container image being scanned.","type":"string"}},"type":"object"},"AnalyzePackagesResponse":{"description":"AnalyzePackagesResponse contains the information necessary to find results for the given scan.","properties":{"scan":{"description":"The name of the scan resource created by this successful scan.","type":"string"}},"type":"object"},"AnalyzePackagesResponseV1":{"description":"AnalyzePackagesResponse contains the information necessary to find results for the given scan.","properties":{"scan":{"description":"The name of the scan resource created by this successful scan.","type":"string"}},"type":"object"},"Artifact":{"description":"Artifact describes a build product.","properties":{"checksum":{"description":"Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.","type":"string"},"id":{"description":"Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.","type":"string"},"names":{"description":"Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.","items":{"type":"string"},"type":"array"}},"type":"object"},"AttestationOccurrence":{"description":"Occurrence that represents a single \"attestation\". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign.","properties":{"jwts":{"description":"One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.","items":{"$ref":"#/components/schemas/Jwt"},"type":"array"},"serializedPayload":{"description":"Required. The serialized payload that is verified by one or more `signatures`.","format":"byte","type":"string"},"signatures":{"description":"One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.","items":{"$ref":"#/components/schemas/Signature"},"type":"array"}},"type":"object"},"BinarySourceInfo":{"properties":{"binaryVersion":{"$ref":"#/components/schemas/PackageVersion","description":"The binary package. This is significant when the source is different than the binary itself. Historically if they've differed, we'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's what's actually installed. See b/175908657#comment15."},"sourceVersion":{"$ref":"#/components/schemas/PackageVersion","description":"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."}},"type":"object"},"BuildDefinition":{"properties":{"buildType":{"type":"string"},"externalParameters":{"additionalProperties":{"description":"Properties of the object."},"type":"object"},"internalParameters":{"additionalProperties":{"description":"Properties of the object."},"type":"object"},"resolvedDependencies":{"items":{"$ref":"#/components/schemas/ResourceDescriptor"},"type":"array"}},"type":"object"},"BuildMetadata":{"properties":{"finishedOn":{"format":"google-datetime","type":"string"},"invocationId":{"type":"string"},"startedOn":{"format":"google-datetime","type":"string"}},"type":"object"},"BuildOccurrence":{"description":"Details of a build occurrence.","properties":{"inTotoSlsaProvenanceV1":{"$ref":"#/components/schemas/InTotoSlsaProvenanceV1","description":"In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance."},"intotoProvenance":{"$ref":"#/components/schemas/InTotoProvenance","description":"Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec."},"intotoStatement":{"$ref":"#/components/schemas/InTotoStatement","description":"In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope."},"provenance":{"$ref":"#/components/schemas/BuildProvenance","description":"The actual provenance for the build."},"provenanceBytes":{"description":"Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.","type":"string"}},"type":"object"},"BuildProvenance":{"description":"Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.","properties":{"buildOptions":{"additionalProperties":{"type":"string"},"description":"Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.","type":"object"},"builderVersion":{"description":"Version string of the builder at the time this build was executed.","type":"string"},"builtArtifacts":{"description":"Output of the build.","items":{"$ref":"#/components/schemas/Artifact"},"type":"array"},"commands":{"description":"Commands requested by the build.","items":{"$ref":"#/components/schemas/Command"},"type":"array"},"createTime":{"description":"Time at which the build was created.","format":"google-datetime","type":"string"},"creator":{"description":"E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.","type":"string"},"endTime":{"description":"Time at which execution of the build was finished.","format":"google-datetime","type":"string"},"id":{"description":"Required. Unique identifier of the build.","type":"string"},"logsUri":{"description":"URI where any logs for this provenance were written.","type":"string"},"projectId":{"description":"ID of the project.","type":"string"},"sourceProvenance":{"$ref":"#/components/schemas/Source","description":"Details of the Source input to the build."},"startTime":{"description":"Time at which execution of the build was started.","format":"google-datetime","type":"string"},"triggerId":{"description":"Trigger identifier if the build was triggered automatically; empty if not.","type":"string"}},"type":"object"},"BuilderConfig":{"properties":{"id":{"type":"string"}},"type":"object"},"CVSS":{"description":"Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version.","properties":{"attackComplexity":{"enum":["ATTACK_COMPLEXITY_UNSPECIFIED","ATTACK_COMPLEXITY_LOW","ATTACK_COMPLEXITY_HIGH","ATTACK_COMPLEXITY_MEDIUM"],"type":"string"},"attackVector":{"description":"Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.","enum":["ATTACK_VECTOR_UNSPECIFIED","ATTACK_VECTOR_NETWORK","ATTACK_VECTOR_ADJACENT","ATTACK_VECTOR_LOCAL","ATTACK_VECTOR_PHYSICAL"],"type":"string"},"authentication":{"enum":["AUTHENTICATION_UNSPECIFIED","AUTHENTICATION_MULTIPLE","AUTHENTICATION_SINGLE","AUTHENTICATION_NONE"],"type":"string"},"availabilityImpact":{"enum":["IMPACT_UNSPECIFIED","IMPACT_HIGH","IMPACT_LOW","IMPACT_NONE","IMPACT_PARTIAL","IMPACT_COMPLETE"],"type":"string"},"baseScore":{"description":"The base score is a function of the base metric scores.","format":"float","type":"number"},"confidentialityImpact":{"enum":["IMPACT_UNSPECIFIED","IMPACT_HIGH","IMPACT_LOW","IMPACT_NONE","IMPACT_PARTIAL","IMPACT_COMPLETE"],"type":"string"},"exploitabilityScore":{"format":"float","type":"number"},"impactScore":{"format":"float","type":"number"},"integrityImpact":{"enum":["IMPACT_UNSPECIFIED","IMPACT_HIGH","IMPACT_LOW","IMPACT_NONE","IMPACT_PARTIAL","IMPACT_COMPLETE"],"type":"string"},"privilegesRequired":{"enum":["PRIVILEGES_REQUIRED_UNSPECIFIED","PRIVILEGES_REQUIRED_NONE","PRIVILEGES_REQUIRED_LOW","PRIVILEGES_REQUIRED_HIGH"],"type":"string"},"scope":{"enum":["SCOPE_UNSPECIFIED","SCOPE_UNCHANGED","SCOPE_CHANGED"],"type":"string"},"userInteraction":{"enum":["USER_INTERACTION_UNSPECIFIED","USER_INTERACTION_NONE","USER_INTERACTION_REQUIRED"],"type":"string"}},"type":"object"},"Category":{"description":"The category to which the update belongs.","properties":{"categoryId":{"description":"The identifier of the category.","type":"string"},"name":{"description":"The localized name of the category.","type":"string"}},"type":"object"},"CloudRepoSourceContext":{"description":"A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.","properties":{"aliasContext":{"$ref":"#/components/schemas/AliasContext","description":"An alias, which may be a branch or tag."},"repoId":{"$ref":"#/components/schemas/RepoId","description":"The ID of the repo."},"revisionId":{"description":"A revision ID.","type":"string"}},"type":"object"},"Command":{"description":"Command describes a step performed as part of the build pipeline.","properties":{"args":{"description":"Command-line arguments used when executing this command.","items":{"type":"string"},"type":"array"},"dir":{"description":"Working directory (relative to project source root) used when running this command.","type":"string"},"env":{"description":"Environment variables set before running this command.","items":{"type":"string"},"type":"array"},"id":{"description":"Optional unique identifier for this command, used in wait_for to reference this command as a dependency.","type":"string"},"name":{"description":"Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.","type":"string"},"waitFor":{"description":"The ID(s) of the command(s) that this command depends on.","items":{"type":"string"},"type":"array"}},"type":"object"},"Completeness":{"description":"Indicates that the builder claims certain fields in this message to be complete.","properties":{"arguments":{"description":"If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.","type":"boolean"},"environment":{"description":"If true, the builder claims that recipe.environment is claimed to be complete.","type":"boolean"},"materials":{"description":"If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called \"hermetic\".","type":"boolean"}},"type":"object"},"ComplianceOccurrence":{"description":"An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason.","properties":{"nonComplianceReason":{"type":"string"},"nonCompliantFiles":{"items":{"$ref":"#/components/schemas/NonCompliantFile"},"type":"array"}},"type":"object"},"DSSEAttestationOccurrence":{"description":"Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence.","properties":{"envelope":{"$ref":"#/components/schemas/Envelope","description":"If doing something security critical, make sure to verify the signatures in this metadata."},"statement":{"$ref":"#/components/schemas/InTotoStatement"}},"type":"object"},"DeploymentOccurrence":{"description":"The period during which some deployable was active in a runtime.","properties":{"address":{"description":"Address of the runtime element hosting this deployment.","type":"string"},"config":{"description":"Configuration used to create this deployment.","type":"string"},"deployTime":{"description":"Required. Beginning of the lifetime of this deployment.","format":"google-datetime","type":"string"},"platform":{"description":"Platform hosting this deployment.","enum":["PLATFORM_UNSPECIFIED","GKE","FLEX","CUSTOM"],"type":"string"},"resourceUri":{"description":"Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.","items":{"type":"string"},"type":"array"},"undeployTime":{"description":"End of the lifetime of this deployment.","format":"google-datetime","type":"string"},"userEmail":{"description":"Identity of the user that triggered this deployment.","type":"string"}},"type":"object"},"DiscoveryOccurrence":{"description":"Provides information about the analysis status of a discovered resource.","properties":{"analysisCompleted":{"$ref":"#/components/schemas/AnalysisCompleted"},"analysisError":{"description":"Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.","items":{"$ref":"#/components/schemas/Status"},"type":"array"},"analysisStatus":{"description":"The status of discovery for the resource.","enum":["ANALYSIS_STATUS_UNSPECIFIED","PENDING","SCANNING","FINISHED_SUCCESS","COMPLETE","FINISHED_FAILED","FINISHED_UNSUPPORTED"],"type":"string"},"analysisStatusError":{"$ref":"#/components/schemas/Status","description":"When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API."},"archiveTime":{"description":"Output only. The time occurrences related to this discovery occurrence were archived.","format":"google-datetime","readOnly":true,"type":"string"},"continuousAnalysis":{"description":"Whether the resource is continuously analyzed.","enum":["CONTINUOUS_ANALYSIS_UNSPECIFIED","ACTIVE","INACTIVE"],"type":"string"},"cpe":{"description":"The CPE of the resource being scanned.","type":"string"},"lastScanTime":{"description":"The last time this resource was scanned.","format":"google-datetime","type":"string"},"sbomStatus":{"$ref":"#/components/schemas/SBOMStatus","description":"The status of an SBOM generation."}},"type":"object"},"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","properties":{},"type":"object"},"Envelope":{"description":"MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.","properties":{"payload":{"format":"byte","type":"string"},"payloadType":{"type":"string"},"signatures":{"items":{"$ref":"#/components/schemas/EnvelopeSignature"},"type":"array"}},"type":"object"},"EnvelopeSignature":{"properties":{"keyid":{"type":"string"},"sig":{"format":"byte","type":"string"}},"type":"object"},"FileHashes":{"description":"Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.","properties":{"fileHash":{"description":"Required. Collection of file hashes.","items":{"$ref":"#/components/schemas/Hash"},"type":"array"}},"type":"object"},"FileLocation":{"description":"Indicates the location at which a package was found.","properties":{"filePath":{"description":"For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.","type":"string"}},"type":"object"},"Fingerprint":{"description":"A set of properties that uniquely identify a given Docker image.","properties":{"v1Name":{"description":"Required. The layer ID of the final layer in the Docker image's v1 representation.","type":"string"},"v2Blob":{"description":"Required. The ordered list of v2 blobs that represent a given image.","items":{"type":"string"},"type":"array"},"v2Name":{"description":"Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + \" \" + v2_name[N+1]) Only the name of the final blob is kept.","type":"string"}},"type":"object"},"GerritSourceContext":{"description":"A SourceContext referring to a Gerrit project.","properties":{"aliasContext":{"$ref":"#/components/schemas/AliasContext","description":"An alias, which may be a branch or tag."},"gerritProject":{"description":"The full project name within the host. Projects may be nested, so \"project/subproject\" is a valid project name. The \"repo name\" is the hostURI/project.","type":"string"},"hostUri":{"description":"The URI of a running Gerrit instance.","type":"string"},"revisionId":{"description":"A revision (commit) ID.","type":"string"}},"type":"object"},"GitSourceContext":{"description":"A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).","properties":{"revisionId":{"description":"Git commit hash.","type":"string"},"url":{"description":"Git repository URL.","type":"string"}},"type":"object"},"GrafeasV1FileLocation":{"description":"Indicates the location at which a package was found.","properties":{"filePath":{"description":"For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.","type":"string"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder":{"description":"Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.","properties":{"id":{"type":"string"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness":{"description":"Indicates that the builder claims certain fields in this message to be complete.","properties":{"environment":{"type":"boolean"},"materials":{"type":"boolean"},"parameters":{"type":"boolean"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource":{"description":"Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.","properties":{"digest":{"additionalProperties":{"type":"string"},"type":"object"},"entryPoint":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation":{"description":"Identifies the event that kicked off the build.","properties":{"configSource":{"$ref":"#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource"},"environment":{"additionalProperties":{"description":"Properties of the object."},"type":"object"},"parameters":{"additionalProperties":{"description":"Properties of the object."},"type":"object"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial":{"description":"The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.","properties":{"digest":{"additionalProperties":{"type":"string"},"type":"object"},"uri":{"type":"string"}},"type":"object"},"GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata":{"description":"Other properties of the build.","properties":{"buildFinishedOn":{"format":"google-datetime","type":"string"},"buildInvocationId":{"type":"string"},"buildStartedOn":{"format":"google-datetime","type":"string"},"completeness":{"$ref":"#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness"},"reproducible":{"type":"boolean"}},"type":"object"},"Hash":{"description":"Container message for hash values.","properties":{"type":{"description":"Required. The type of hash that was performed, e.g. \"SHA-256\".","type":"string"},"value":{"description":"Required. The hash value.","format":"byte","type":"string"}},"type":"object"},"Identity":{"description":"The unique identifier of the update.","properties":{"revision":{"description":"The revision number of the update.","format":"int32","type":"integer"},"updateId":{"description":"The revision independent identifier of the update.","type":"string"}},"type":"object"},"ImageOccurrence":{"description":"Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM .","properties":{"baseResourceUrl":{"description":"Output only. This contains the base image URL for the derived image occurrence.","type":"string"},"distance":{"description":"Output only. The number of layers by which this image differs from the associated image basis.","format":"int32","type":"integer"},"fingerprint":{"$ref":"#/components/schemas/Fingerprint","description":"Required. The fingerprint of the derived image."},"layerInfo":{"description":"This contains layer-specific metadata, if populated it has length \"distance\" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.","items":{"$ref":"#/components/schemas/Layer"},"type":"array"}},"type":"object"},"InTotoProvenance":{"properties":{"builderConfig":{"$ref":"#/components/schemas/BuilderConfig","description":"required"},"materials":{"description":"The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.","items":{"type":"string"},"type":"array"},"metadata":{"$ref":"#/components/schemas/Metadata"},"recipe":{"$ref":"#/components/schemas/Recipe","description":"Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required"}},"type":"object"},"InTotoSlsaProvenanceV1":{"properties":{"_type":{"description":"InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement","type":"string"},"predicate":{"$ref":"#/components/schemas/SlsaProvenanceV1"},"predicateType":{"type":"string"},"subject":{"items":{"$ref":"#/components/schemas/Subject"},"type":"array"}},"type":"object"},"InTotoStatement":{"description":"Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always \"application/vnd.in-toto+json\".","properties":{"_type":{"description":"Always `https://in-toto.io/Statement/v0.1`.","type":"string"},"predicateType":{"description":"`https://slsa.dev/provenance/v0.1` for SlsaProvenance.","type":"string"},"provenance":{"$ref":"#/components/schemas/InTotoProvenance"},"slsaProvenance":{"$ref":"#/components/schemas/SlsaProvenance"},"slsaProvenanceZeroTwo":{"$ref":"#/components/schemas/SlsaProvenanceZeroTwo"},"subject":{"items":{"$ref":"#/components/schemas/Subject"},"type":"array"}},"type":"object"},"Justification":{"description":"Justification provides the justification when the state of the assessment if NOT_AFFECTED.","properties":{"details":{"description":"Additional details on why this justification was chosen.","type":"string"},"justificationType":{"description":"The justification type for this vulnerability.","enum":["JUSTIFICATION_TYPE_UNSPECIFIED","COMPONENT_NOT_PRESENT","VULNERABLE_CODE_NOT_PRESENT","VULNERABLE_CODE_NOT_IN_EXECUTE_PATH","VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY","INLINE_MITIGATIONS_ALREADY_EXIST"],"type":"string"}},"type":"object"},"Jwt":{"properties":{"compactJwt":{"description":"The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1","type":"string"}},"type":"object"},"LanguagePackageDependency":{"description":"Indicates a language package available between this package and the customer's resource artifact.","properties":{"package":{"type":"string"},"version":{"type":"string"}},"type":"object"},"Layer":{"description":"Layer holds metadata specific to a layer of a Docker image.","properties":{"arguments":{"description":"The recovered arguments to the Dockerfile directive.","type":"string"},"directive":{"description":"Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.","type":"string"}},"type":"object"},"License":{"description":"License information.","properties":{"comments":{"description":"Comments","type":"string"},"expression":{"description":"Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: \"LGPL-2.1-only OR MIT\", \"LGPL-2.1-only AND MIT\", \"GPL-2.0-or-later WITH Bison-exception-2.2\".","type":"string"}},"type":"object"},"ListOperationsResponse":{"description":"The response message for Operations.ListOperations.","properties":{"nextPageToken":{"description":"The standard List next-page token.","type":"string"},"operations":{"description":"A list of operations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"type":"object"},"ListVulnerabilitiesResponse":{"description":"ListVulnerabilitiesResponse contains a single page of vulnerabilities resulting from a scan.","properties":{"nextPageToken":{"description":"A page token that can be used in a subsequent call to ListVulnerabilities to continue retrieving results.","type":"string"},"occurrences":{"description":"The list of Vulnerability Occurrences resulting from a scan.","items":{"$ref":"#/components/schemas/Occurrence"},"type":"array"}},"type":"object"},"Location":{"description":"An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.","properties":{"cpeUri":{"description":"Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)","type":"string"},"path":{"description":"The path from which we gathered that this package/version is installed.","type":"string"},"version":{"$ref":"#/components/schemas/Version","description":"Deprecated. The version installed at this location."}},"type":"object"},"Maintainer":{"properties":{"email":{"type":"string"},"kind":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"type":"object"},"Material":{"properties":{"digest":{"additionalProperties":{"type":"string"},"type":"object"},"uri":{"type":"string"}},"type":"object"},"Metadata":{"description":"Other properties of the build.","properties":{"buildFinishedOn":{"description":"The timestamp of when the build completed.","format":"google-datetime","type":"string"},"buildInvocationId":{"description":"Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.","type":"string"},"buildStartedOn":{"description":"The timestamp of when the build started.","format":"google-datetime","type":"string"},"completeness":{"$ref":"#/components/schemas/Completeness","description":"Indicates that the builder claims certain fields in this message to be complete."},"reproducible":{"description":"If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.","type":"boolean"}},"type":"object"},"NonCompliantFile":{"description":"Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.","properties":{"displayCommand":{"description":"Command to display the non-compliant files.","type":"string"},"path":{"description":"Empty if `display_command` is set.","type":"string"},"reason":{"description":"Explains why a file is non compliant for a CIS check.","type":"string"}},"type":"object"},"Occurrence":{"description":"An instance of an analysis type that has been found on a resource.","properties":{"attestation":{"$ref":"#/components/schemas/AttestationOccurrence","description":"Describes an attestation of an artifact."},"build":{"$ref":"#/components/schemas/BuildOccurrence","description":"Describes a verifiable build."},"compliance":{"$ref":"#/components/schemas/ComplianceOccurrence","description":"Describes a compliance violation on a linked resource."},"createTime":{"description":"Output only. The time this occurrence was created.","format":"google-datetime","type":"string"},"deployment":{"$ref":"#/components/schemas/DeploymentOccurrence","description":"Describes the deployment of an artifact on a runtime."},"discovery":{"$ref":"#/components/schemas/DiscoveryOccurrence","description":"Describes when a resource was discovered."},"dsseAttestation":{"$ref":"#/components/schemas/DSSEAttestationOccurrence","description":"Describes an attestation of an artifact using dsse."},"envelope":{"$ref":"#/components/schemas/Envelope","description":"https://github.com/secure-systems-lab/dsse"},"image":{"$ref":"#/components/schemas/ImageOccurrence","description":"Describes how this resource derives from the basis in the associated note."},"kind":{"description":"Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.","enum":["NOTE_KIND_UNSPECIFIED","VULNERABILITY","BUILD","IMAGE","PACKAGE","DEPLOYMENT","DISCOVERY","ATTESTATION","UPGRADE","COMPLIANCE","DSSE_ATTESTATION","VULNERABILITY_ASSESSMENT","SBOM_REFERENCE"],"type":"string"},"name":{"description":"Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.","type":"string"},"noteName":{"description":"Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.","type":"string"},"package":{"$ref":"#/components/schemas/PackageOccurrence","description":"Describes the installation of a package on the linked resource."},"remediation":{"description":"A description of actions that can be taken to remedy the note.","type":"string"},"resourceUri":{"description":"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.","type":"string"},"sbomReference":{"$ref":"#/components/schemas/SBOMReferenceOccurrence","description":"Describes a specific SBOM reference occurrences."},"updateTime":{"description":"Output only. The time this occurrence was last updated.","format":"google-datetime","type":"string"},"upgrade":{"$ref":"#/components/schemas/UpgradeOccurrence","description":"Describes an available package upgrade on the linked resource."},"vulnerability":{"$ref":"#/components/schemas/VulnerabilityOccurrence","description":"Describes a security vulnerability."}},"type":"object"},"Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.","type":"boolean"},"error":{"$ref":"#/components/schemas/Status","description":"The error result of the operation in case of failure or cancellation."},"metadata":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.","type":"object"},"name":{"description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.","type":"string"},"response":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.","type":"object"}},"type":"object"},"PackageData":{"properties":{"architecture":{"description":"The architecture of the package.","type":"string"},"binarySourceInfo":{"description":"A bundle containing the binary and source information.","items":{"$ref":"#/components/schemas/BinarySourceInfo"},"type":"array"},"binaryVersion":{"$ref":"#/components/schemas/PackageVersion","description":"DEPRECATED"},"cpeUri":{"description":"The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability may manifest. Examples include distro or storage location for vulnerable jar.","type":"string"},"dependencyChain":{"description":"The dependency chain between this package and the user's artifact. List in order from the customer's package under review first, to the current package last. Inclusive of the original package and the current package.","items":{"$ref":"#/components/schemas/LanguagePackageDependency"},"type":"array"},"fileLocation":{"description":"The path to the jar file / go binary file.","items":{"$ref":"#/components/schemas/FileLocation"},"type":"array"},"hashDigest":{"description":"HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.","type":"string"},"licenses":{"description":"The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos,