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

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

{"openapi":"3.0.0","servers":[{"url":"https://containeranalysis.googleapis.com/"}],"x-hasEquivalentPaths":true,"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Container Analysis API","version":"v1beta1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"format":"google","url":"https://containeranalysis.googleapis.com/$discovery/rest?version=v1beta1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"containeranalysis"},"externalDocs":{"url":"https://cloud.google.com/container-analysis/api/reference/rest/"},"tags":[{"name":"projects"}],"paths":{"/v1beta1/{name}":{"delete":{"description":"Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.","operationId":"containeranalysis.projects.occurrences.delete","parameters":[{"description":"Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.","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 specified occurrence.","operationId":"containeranalysis.projects.occurrences.get","parameters":[{"description":"Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Occurrence"}}},"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"}],"patch":{"description":"Updates the specified occurrence.","operationId":"containeranalysis.projects.occurrences.patch","parameters":[{"description":"Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The fields to update.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Occurrence"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Occurrence"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{name}/notes":{"get":{"description":"Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.","operationId":"containeranalysis.projects.occurrences.getNotes","parameters":[{"description":"Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"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}/occurrences":{"get":{"description":"Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.","operationId":"containeranalysis.projects.notes.occurrences.list","parameters":[{"description":"Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The filter expression.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Number of occurrences to return in the list.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Token to provide to skip to a particular spot in the list.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNoteOccurrencesResponse"}}},"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}:exportSBOM":{"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":"Generates an SBOM and other dependency information for the given resource.","operationId":"containeranalysis.projects.resources.exportSBOM","parameters":[{"description":"Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportSBOMRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportSBOMResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{name}:generatePackagesSummary":{"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":"Gets a summary of the packages within a given resource.","operationId":"containeranalysis.projects.resources.generatePackagesSummary","parameters":[{"description":"Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratePackagesSummaryRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagesSummaryResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/notes":{"get":{"description":"Lists notes for the specified project.","operationId":"containeranalysis.projects.notes.list","parameters":[{"description":"Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The filter expression.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Token to provide to skip to a particular spot in the list.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotesResponse"}}},"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"}],"post":{"description":"Creates a new note.","operationId":"containeranalysis.projects.notes.create","parameters":[{"description":"Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The ID to use for this note.","in":"query","name":"noteId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/notes:batchCreate":{"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":"Creates new notes in batch.","operationId":"containeranalysis.projects.notes.batchCreate","parameters":[{"description":"Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateNotesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateNotesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/occurrences":{"get":{"description":"Lists occurrences for the specified project.","operationId":"containeranalysis.projects.occurrences.list","parameters":[{"description":"Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The filter expression.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Token to provide to skip to a particular spot in the list.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOccurrencesResponse"}}},"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"}],"post":{"description":"Creates a new occurrence.","operationId":"containeranalysis.projects.occurrences.create","parameters":[{"description":"Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Occurrence"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Occurrence"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/occurrences:batchCreate":{"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":"Creates new occurrences in batch.","operationId":"containeranalysis.projects.occurrences.batchCreate","parameters":[{"description":"Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateOccurrencesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateOccurrencesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{parent}/occurrences:vulnerabilitySummary":{"get":{"description":"Gets a summary of the number and severity of occurrences.","operationId":"containeranalysis.projects.occurrences.getVulnerabilitySummary","parameters":[{"description":"Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The filter expression.","in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityOccurrencesSummary"}}},"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/{resource}:getIamPolicy":{"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":"Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.","operationId":"containeranalysis.projects.occurrences.getIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIamPolicyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{resource}:setIamPolicy":{"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":"Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.","operationId":"containeranalysis.projects.occurrences.setIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta1/{resource}:testIamPermissions":{"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":"Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.","operationId":"containeranalysis.projects.occurrences.testIamPermissions","parameters":[{"description":"REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"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"},"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"},"ArtifactHashes":{"description":"Defines a hash object for use in Materials and Products.","properties":{"sha256":{"type":"string"}},"type":"object"},"ArtifactRule":{"description":"Defines an object to declare an in-toto artifact rule","properties":{"artifactRule":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Assessment":{"description":"Assessment provides all information that is related to a single vulnerability for this product.","properties":{"cve":{"deprecated":true,"description":"Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.","type":"string"},"impacts":{"description":"Contains information about the impact of this vulnerability, this will change with time.","items":{"type":"string"},"type":"array"},"justification":{"$ref":"#/components/schemas/Justification","description":"Justification provides the justification when the state of the assessment if NOT_AFFECTED."},"longDescription":{"description":"A detailed description of this Vex.","type":"string"},"relatedUris":{"description":"Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.","items":{"$ref":"#/components/schemas/RelatedUrl"},"type":"array"},"remediations":{"description":"Specifies details on how to handle (and presumably, fix) a vulnerability.","items":{"$ref":"#/components/schemas/Remediation"},"type":"array"},"shortDescription":{"description":"A one sentence description of this Vex.","type":"string"},"state":{"description":"Provides the state of this Vulnerability assessment.","enum":["STATE_UNSPECIFIED","AFFECTED","NOT_AFFECTED","FIXED","UNDER_INVESTIGATION"],"type":"string"},"vulnerabilityId":{"description":"The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.","type":"string"}},"type":"object"},"Attestation":{"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 look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for).","properties":{"genericSignedAttestation":{"$ref":"#/components/schemas/GenericSignedAttestation"},"pgpSignedAttestation":{"$ref":"#/components/schemas/PgpSignedAttestation","description":"A PGP signed attestation."}},"type":"object"},"Authority":{"description":"Note kind that represents a logical attestation \"role\" or \"authority\". For example, an organization might have one `Authority` for \"QA\" and one for \"build\". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.","properties":{"hint":{"$ref":"#/components/schemas/Hint","description":"Hint hints at the purpose of the attestation authority."}},"type":"object"},"Basis":{"description":"Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url.","properties":{"fingerprint":{"$ref":"#/components/schemas/Fingerprint","description":"Required. Immutable. The fingerprint of the base image."},"resourceUrl":{"description":"Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.","type":"string"}},"type":"object"},"BatchCreateNotesRequest":{"description":"Request to create notes in batch.","properties":{"notes":{"additionalProperties":{"$ref":"#/components/schemas/Note"},"description":"Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.","type":"object"}},"type":"object"},"BatchCreateNotesResponse":{"description":"Response for creating notes in batch.","properties":{"notes":{"description":"The notes that were created.","items":{"$ref":"#/components/schemas/Note"},"type":"array"}},"type":"object"},"BatchCreateOccurrencesRequest":{"description":"Request to create occurrences in batch.","properties":{"occurrences":{"description":"Required. The occurrences to create. Max allowed length is 1000.","items":{"$ref":"#/components/schemas/Occurrence"},"type":"array"}},"type":"object"},"BatchCreateOccurrencesResponse":{"description":"Response for creating occurrences in batch.","properties":{"occurrences":{"description":"The occurrences that were created.","items":{"$ref":"#/components/schemas/Occurrence"},"type":"array"}},"type":"object"},"Binding":{"description":"Associates `members`, or principals, with a `role`.","properties":{"condition":{"$ref":"#/components/schemas/Expr","description":"The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."},"members":{"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.","items":{"type":"string"},"type":"array"},"role":{"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"}},"type":"object"},"Build":{"description":"Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.","properties":{"builderVersion":{"description":"Required. Immutable. Version of the builder which produced this build.","type":"string"},"signature":{"$ref":"#/components/schemas/BuildSignature","description":"Signature of the build in occurrences pointing to this build note containing build details."}},"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"},"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"},"BuildSignature":{"description":"Message encapsulating the signature of the verified build.","properties":{"keyId":{"description":"An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).","type":"string"},"keyType":{"description":"The type of the key, either stored in `public_key` or referenced in `key_id`.","enum":["KEY_TYPE_UNSPECIFIED","PGP_ASCII_ARMORED","PKIX_PEM"],"type":"string"},"publicKey":{"description":"Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`","type":"string"},"signature":{"description":"Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.","format":"byte","type":"string"}},"type":"object"},"BuildStep":{"description":"A step in the build pipeline. Next ID: 21","properties":{"allowExitCodes":{"description":"Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.","items":{"format":"int32","type":"integer"},"type":"array"},"allowFailure":{"description":"Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.","type":"boolean"},"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"},"automapSubstitutions":{"description":"Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.","type":"boolean"},"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"},"exitCode":{"description":"Output only. Return code from running the step.","format":"int32","type":"integer"},"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":"#/components/schemas/TimeSpan","description":"Output only. Stores timing information for pulling this build step's builder image only."},"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","QUEUING","QUEUED","WORKING","SUCCESS","FAILURE","INTERNAL_ERROR","TIMEOUT","CANCELLED","EXPIRED"],"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":"#/components/schemas/TimeSpan","description":"Output only. Stores timing information for executing this build step."},"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":"#/components/schemas/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\".","properties":{"customValues":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"CVSS":{"description":"Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator","properties":{"attackComplexity":{"description":"Defined in CVSS v3, CVSS v2","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. Defined in CVSS v3, CVSS v2","enum":["ATTACK_VECTOR_UNSPECIFIED","ATTACK_VECTOR_NETWORK","ATTACK_VECTOR_ADJACENT","ATTACK_VECTOR_LOCAL","ATTACK_VECTOR_PHYSICAL"],"type":"string"},"authentication":{"description":"Defined in CVSS v2","enum":["AUTHENTICATION_UNSPECIFIED","AUTHENTICATION_MULTIPLE","AUTHENTICATION_SINGLE","AUTHENTICATION_NONE"],"type":"string"},"availabilityImpact":{"description":"Defined in CVSS v3, CVSS v2","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":{"description":"Defined in CVSS v3, CVSS v2","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":{"description":"Defined in CVSS v3, CVSS v2","enum":["IMPACT_UNSPECIFIED","IMPACT_HIGH","IMPACT_LOW","IMPACT_NONE","IMPACT_PARTIAL","IMPACT_COMPLETE"],"type":"string"},"privilegesRequired":{"description":"Defined in CVSS v3","enum":["PRIVILEGES_REQUIRED_UNSPECIFIED","PRIVILEGES_REQUIRED_NONE","PRIVILEGES_REQUIRED_LOW","PRIVILEGES_REQUIRED_HIGH"],"type":"string"},"scope":{"description":"Defined in CVSS v3","enum":["SCOPE_UNSPECIFIED","SCOPE_UNCHANGED","SCOPE_CHANGED"],"type":"string"},"userInteraction":{"description":"Defined in CVSS v3","enum":["USER_INTERACTION_UNSPECIFIED","USER_INTERACTION_NONE","USER_INTERACTION_REQUIRED"],"type":"string"}},"type":"object"},"CVSSv3":{"description":"Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document","properties":{"attackComplexity":{"enum":["ATTACK_COMPLEXITY_UNSPECIFIED","ATTACK_COMPLEXITY_LOW","ATTACK_COMPLEXITY_HIGH"],"type":"string"},"attackVector":{"description":"Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant