blob: 6a41f231c5b9f6c2dc1f08101c89ed07a024a2e2 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://artifactregistry.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Artifact Registry",
"description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/artifacts/docs/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "artifactregistry:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://artifactregistry.mtls.googleapis.com/",
"name": "artifactregistry",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"operations": {
"methods": {
"cancel": {
"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`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "artifactregistry.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "artifactregistry.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "artifactregistry.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "artifactregistry.operations.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"projects": {
"resources": {
"locations": {
"resources": {
"repositories": {
"methods": {
"get": {
"description": "Gets a repository.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.repositories.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the repository to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Repository"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists repositories.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.repositories.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of repositories to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource whose repositories will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/repositories",
"response": {
"$ref": "ListRepositoriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
"resources": {
"dockerImages": {
"methods": {
"list": {
"description": "Lists docker images.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/dockerImages",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.repositories.dockerImages.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of artifacts to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource whose docker images will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dockerImages",
"response": {
"$ref": "ListDockerImagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20210803",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"AptArtifact": {
"description": "A detailed representation of an Apt artifact. Information in the record is derived from the archive's control file. See https://www.debian.org/doc/debian-policy/ch-controlfields.html",
"id": "AptArtifact",
"properties": {
"architecture": {
"description": "Output only. Operating system architecture of the artifact.",
"readOnly": true,
"type": "string"
},
"component": {
"description": "Output only. Repository component of the artifact.",
"readOnly": true,
"type": "string"
},
"controlFile": {
"description": "Output only. Contents of the artifact's control metadata file.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The Artifact Registry resource name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageName": {
"description": "Output only. The Apt package name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageType": {
"description": "Output only. An artifact is a binary or source package.",
"enum": [
"PACKAGE_TYPE_UNSPECIFIED",
"BINARY",
"SOURCE"
],
"enumDescriptions": [
"Package type is not specified.",
"Binary package.",
"Source package."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"DockerImage": {
"description": "DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes): - imageSizeBytes - mediaType - buildTime",
"id": "DockerImage",
"properties": {
"buildTime": {
"description": "The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor and keeps the Version timestamps returned via OnePlatform consistent, as JSON marshals google.protobuf.Timestamp into an RFC 3339 string.",
"format": "google-datetime",
"type": "string"
},
"imageSizeBytes": {
"description": "Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource.",
"format": "int64",
"type": "string"
},
"mediaType": {
"description": "Media type of this image, e.g. \"application/vnd.docker.distribution.manifest.v2+json\". This field is returned as the 'metadata.mediaType' field in the Version resource.",
"type": "string"
},
"name": {
"description": "Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repository//dockerImages/`. For example, \"projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\", where \"us-west4\" is the registry_location, \"test-project\" is the project_id, \"test-repo\" is the repository_name and \"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\" is the image's digest.",
"type": "string"
},
"tags": {
"description": "Tags attached to this image.",
"items": {
"type": "string"
},
"type": "array"
},
"uploadTime": {
"description": "Time the image was uploaded.",
"format": "google-datetime",
"type": "string"
},
"uri": {
"description": "Required. URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf",
"type": "string"
}
},
"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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"ImportAptArtifactsErrorInfo": {
"description": "Error information explaining why a package was not imported.",
"id": "ImportAptArtifactsErrorInfo",
"properties": {
"error": {
"$ref": "Status",
"description": "The detailed error status."
},
"gcsSource": {
"$ref": "ImportAptArtifactsGcsSource",
"description": "Google Cloud Storage location requested."
}
},
"type": "object"
},
"ImportAptArtifactsGcsSource": {
"description": "Google Cloud Storage location where the artifacts currently reside.",
"id": "ImportAptArtifactsGcsSource",
"properties": {
"uris": {
"description": "Cloud Storage paths URI (e.g., gs://my_bucket//my_object).",
"items": {
"type": "string"
},
"type": "array"
},
"useWildcards": {
"description": "Supports URI wildcards for matching multiple objects from a single URI.",
"type": "boolean"
}
},
"type": "object"
},
"ImportAptArtifactsResponse": {
"description": "The response message from importing artifacts.",
"id": "ImportAptArtifactsResponse",
"properties": {
"aptArtifacts": {
"description": "The Apt artifacts updated.",
"items": {
"$ref": "AptArtifact"
},
"type": "array"
},
"errors": {
"description": "Detailed error info for packages that were not imported.",
"items": {
"$ref": "ImportAptArtifactsErrorInfo"
},
"type": "array"
}
},
"type": "object"
},
"ImportYumArtifactsErrorInfo": {
"description": "Error information explaining why a package was not imported.",
"id": "ImportYumArtifactsErrorInfo",
"properties": {
"error": {
"$ref": "Status",
"description": "The detailed error status."
},
"gcsSource": {
"$ref": "ImportYumArtifactsGcsSource",
"description": "Google Cloud Storage location requested."
}
},
"type": "object"
},
"ImportYumArtifactsGcsSource": {
"description": "Google Cloud Storage location where the artifacts currently reside.",
"id": "ImportYumArtifactsGcsSource",
"properties": {
"uris": {
"description": "Cloud Storage paths URI (e.g., gs://my_bucket//my_object).",
"items": {
"type": "string"
},
"type": "array"
},
"useWildcards": {
"description": "Supports URI wildcards for matching multiple objects from a single URI.",
"type": "boolean"
}
},
"type": "object"
},
"ImportYumArtifactsResponse": {
"description": "The response message from importing artifacts.",
"id": "ImportYumArtifactsResponse",
"properties": {
"errors": {
"description": "Detailed error info for packages that were not imported.",
"items": {
"$ref": "ImportYumArtifactsErrorInfo"
},
"type": "array"
},
"yumArtifacts": {
"description": "The yum artifacts updated.",
"items": {
"$ref": "YumArtifact"
},
"type": "array"
}
},
"type": "object"
},
"ListDockerImagesResponse": {
"description": "The response from listing docker images.",
"id": "ListDockerImagesResponse",
"properties": {
"dockerImages": {
"description": "The docker images returned.",
"items": {
"$ref": "DockerImage"
},
"type": "array"
},
"nextPageToken": {
"description": "The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"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": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListRepositoriesResponse": {
"description": "The response from listing repositories.",
"id": "ListRepositoriesResponse",
"properties": {
"nextPageToken": {
"description": "The token to retrieve the next page of repositories, or empty if there are no more repositories to return.",
"type": "string"
},
"repositories": {
"description": "The repositories returned.",
"items": {
"$ref": "Repository"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"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": "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.",
"type": "any"
},
"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.",
"type": "any"
},
"description": "The normal response of the operation in case of success. 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"
},
"Repository": {
"description": "A Repository for storing artifacts with a specific format.",
"id": "Repository",
"properties": {
"createTime": {
"description": "The time when the repository was created.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "The user-provided description of the repository.",
"type": "string"
},
"format": {
"description": "The format of packages that are stored in the repository.",
"enum": [
"FORMAT_UNSPECIFIED",
"DOCKER",
"MAVEN",
"NPM",
"PYPI",
"APT",
"YUM",
"PYTHON"
],
"enumDescriptions": [
"Unspecified package format.",
"Docker package format.",
"Maven package format.",
"NPM package format.",
"PyPI package format.",
"APT package format.",
"YUM package format.",
"Python package format."
],
"type": "string"
},
"kmsKeyName": {
"description": "The Cloud KMS resource name of the customer managed encryption key that\u2019s used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes.",
"type": "object"
},
"name": {
"description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".",
"type": "string"
},
"updateTime": {
"description": "The time when the repository was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"UploadAptArtifactMediaResponse": {
"description": "The response to upload an artifact.",
"id": "UploadAptArtifactMediaResponse",
"properties": {
"operation": {
"$ref": "Operation",
"description": "Operation to be returned to the user."
}
},
"type": "object"
},
"UploadAptArtifactResponse": {
"description": "The response of the completed artifact upload operation. This response is contained in the Operation and available to users.",
"id": "UploadAptArtifactResponse",
"properties": {
"aptArtifacts": {
"description": "The Apt artifacts updated.",
"items": {
"$ref": "AptArtifact"
},
"type": "array"
}
},
"type": "object"
},
"UploadYumArtifactMediaResponse": {
"description": "The response to upload an artifact.",
"id": "UploadYumArtifactMediaResponse",
"properties": {
"operation": {
"$ref": "Operation",
"description": "Operation to be returned to the user."
}
},
"type": "object"
},
"UploadYumArtifactResponse": {
"description": "The response of the completed artifact upload operation. This response is contained in the Operation and available to users.",
"id": "UploadYumArtifactResponse",
"properties": {
"yumArtifacts": {
"description": "The Apt artifacts updated.",
"items": {
"$ref": "YumArtifact"
},
"type": "array"
}
},
"type": "object"
},
"YumArtifact": {
"description": "A detailed representation of a Yum artifact.",
"id": "YumArtifact",
"properties": {
"architecture": {
"description": "Output only. Operating system architecture of the artifact.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The Artifact Registry resource name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageName": {
"description": "Output only. The yum package name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageType": {
"description": "Output only. An artifact is a binary or source package.",
"enum": [
"PACKAGE_TYPE_UNSPECIFIED",
"BINARY",
"SOURCE"
],
"enumDescriptions": [
"Package type is not specified.",
"Binary package (.rpm). .rpm",
"Source package (.srpm)."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Artifact Registry API",
"version": "v1",
"version_module": true
}