{ "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "httpMethod": "GET", "description": "Lists information about the supported locations for this service.", "flatPath": "v1/projects/{projectsId}/locations", "parameters": { "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "name": { "pattern": "^projects/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "type": "string" } }, "response": { "$ref": "ListLocationsResponse" }, "id": "apigeeregistry.projects.locations.list", "path": "v1/{+name}/locations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Location" }, "id": "apigeeregistry.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "response": { "$ref": "ListOperationsResponse" }, "id": "apigeeregistry.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/operations" }, "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "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/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource." } }, "response": { "$ref": "Operation" }, "id": "apigeeregistry.projects.locations.operations.get" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.operations.delete", "httpMethod": "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/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "cancel": { "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.operations.cancel" } } }, "apis": { "methods": { "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the API to retrieve. Format: `projects/*/locations/*/apis/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path" } }, "response": { "$ref": "Api" }, "id": "apigeeregistry.projects.locations.apis.get", "httpMethod": "GET", "description": "Returns a specified API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Required. The name of the API to delete. Format: `projects/*/locations/*/apis/*`" }, "force": { "location": "query", "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", "type": "boolean" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.apis.delete", "httpMethod": "DELETE", "description": "Removes a specified API and all of the resources that it owns.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}" }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "apigeeregistry.projects.locations.apis.testIamPermissions", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "path": "v1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "setIamPolicy": { "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "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." } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v1/{+parent}/apis", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", "request": { "$ref": "Api" }, "httpMethod": "POST", "description": "Creates a specified API.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`" }, "apiId": { "description": "Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string", "location": "query" } }, "response": { "$ref": "Api" }, "id": "apigeeregistry.projects.locations.apis.create" }, "list": { "description": "Returns matching APIs.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", "id": "apigeeregistry.projects.locations.apis.list", "parameters": { "pageSize": { "description": "The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string", "location": "query" }, "pageToken": { "description": "A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`" }, "filter": { "location": "query", "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", "type": "string" } }, "response": { "$ref": "ListApisResponse" }, "path": "v1/{+parent}/apis", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "patch": { "description": "Used to modify a specified API.", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", "request": { "$ref": "Api" }, "id": "apigeeregistry.projects.locations.apis.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Resource name.", "required": true, "type": "string" }, "updateMask": { "format": "google-fieldmask", "location": "query", "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", "type": "string" }, "allowMissing": { "description": "If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored.", "type": "boolean", "location": "query" } }, "response": { "$ref": "Api" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy", "id": "apigeeregistry.projects.locations.apis.getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "location": "query", "format": "int32" }, "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Policy" } } }, "resources": { "deployments": { "methods": { "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "id": "apigeeregistry.projects.locations.apis.deployments.getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" }, "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path" } }, "response": { "$ref": "Policy" } }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "apigeeregistry.projects.locations.apis.deployments.setIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "path": "v1/{+resource}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "create": { "parameters": { "apiDeploymentId": { "location": "query", "description": "Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`" } }, "response": { "$ref": "ApiDeployment" }, "id": "apigeeregistry.projects.locations.apis.deployments.create", "httpMethod": "POST", "description": "Creates a specified deployment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments", "request": { "$ref": "ApiDeployment" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/deployments" }, "listRevisions": { "id": "apigeeregistry.projects.locations.apis.deployments.listRevisions", "parameters": { "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", "type": "string", "location": "query" }, "name": { "description": "Required. The name of the deployment to list revisions for.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of revisions to return per page.", "type": "integer" } }, "response": { "$ref": "ListApiDeploymentRevisionsResponse" }, "description": "Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:listRevisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:listRevisions" }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "apigeeregistry.projects.locations.apis.deployments.testIamPermissions", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "path": "v1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "rollback": { "path": "v1/{+name}:rollback", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:rollback", "request": { "$ref": "RollbackApiDeploymentRequest" }, "description": "Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.", "httpMethod": "POST", "id": "apigeeregistry.projects.locations.apis.deployments.rollback", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "description": "Required. The deployment being rolled back.", "required": true, "type": "string" } }, "response": { "$ref": "ApiDeployment" } }, "list": { "id": "apigeeregistry.projects.locations.apis.deployments.list", "parameters": { "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.", "type": "string" }, "pageSize": { "description": "The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string" } }, "response": { "$ref": "ListApiDeploymentsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments", "description": "Returns matching deployments.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/deployments" }, "patch": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", "request": { "$ref": "ApiDeployment" }, "httpMethod": "PATCH", "description": "Used to modify a specified deployment.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "description": "Resource name.", "required": true, "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", "type": "string" }, "allowMissing": { "description": "If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.", "type": "boolean", "location": "query" } }, "response": { "$ref": "ApiDeployment" }, "id": "apigeeregistry.projects.locations.apis.deployments.patch" }, "deleteRevision": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:deleteRevision", "parameters": { "name": { "description": "Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ApiDeployment" }, "id": "apigeeregistry.projects.locations.apis.deployments.deleteRevision", "httpMethod": "DELETE", "description": "Deletes a revision of a deployment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:deleteRevision" }, "get": { "httpMethod": "GET", "description": "Returns a specified deployment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the deployment to retrieve. Format: `projects/*/locations/*/apis/*/deployments/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path" } }, "response": { "$ref": "ApiDeployment" }, "id": "apigeeregistry.projects.locations.apis.deployments.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the deployment to delete. Format: `projects/*/locations/*/apis/*/deployments/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path" }, "force": { "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", "type": "boolean", "location": "query" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.apis.deployments.delete" }, "tagRevision": { "parameters": { "name": { "description": "Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ApiDeployment" }, "id": "apigeeregistry.projects.locations.apis.deployments.tagRevision", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:tagRevision", "request": { "$ref": "TagApiDeploymentRevisionRequest" }, "httpMethod": "POST", "description": "Adds a tag to a specified revision of a deployment.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:tagRevision" } }, "resources": { "artifacts": { "methods": { "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}", "httpMethod": "GET", "description": "Returns a specified artifact.", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.get" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.delete", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`" } }, "response": { "$ref": "Empty" }, "description": "Removes a specified artifact.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}" }, "getContents": { "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.getContents", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", "required": true, "type": "string" } }, "response": { "$ref": "HttpBody" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}:getContents", "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:getContents" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/artifacts", "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.list", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", "type": "string" }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ListArtifactsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts", "description": "Returns matching artifacts.", "httpMethod": "GET" }, "replaceArtifact": { "httpMethod": "PUT", "description": "Used to replace a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}", "request": { "$ref": "Artifact" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Resource name.", "required": true, "type": "string" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.replaceArtifact", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/artifacts", "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.create", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", "location": "path" }, "artifactId": { "location": "query", "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" } }, "response": { "$ref": "Artifact" }, "description": "Creates a specified artifact.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts", "request": { "$ref": "Artifact" } } } } } }, "versions": { "methods": { "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "id": "apigeeregistry.projects.locations.apis.versions.testIamPermissions" }, "get": { "id": "apigeeregistry.projects.locations.apis.versions.get", "parameters": { "name": { "description": "Required. The name of the version to retrieve. Format: `projects/*/locations/*/apis/*/versions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ApiVersion" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", "description": "Returns a specified version.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "delete": { "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Removes a specified version and all of the resources that it owns.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", "id": "apigeeregistry.projects.locations.apis.versions.delete", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "description": "Required. The name of the version to delete. Format: `projects/*/locations/*/apis/*/versions/*`" }, "force": { "location": "query", "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", "type": "boolean" } }, "response": { "$ref": "Empty" } }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "format": "int32", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.versions.getIamPolicy" }, "list": { "description": "Returns matching versions.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", "id": "apigeeregistry.projects.locations.apis.versions.list", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string" }, "pageToken": { "description": "A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", "type": "string" }, "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path" } }, "response": { "$ref": "ListApiVersionsResponse" }, "path": "v1/{+parent}/versions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "apigeeregistry.projects.locations.apis.versions.patch", "parameters": { "allowMissing": { "description": "If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.", "type": "boolean", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "description": "Resource name.", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "response": { "$ref": "ApiVersion" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", "request": { "$ref": "ApiVersion" }, "description": "Used to modify a specified version.", "httpMethod": "PATCH" }, "create": { "httpMethod": "POST", "description": "Creates a specified version.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", "request": { "$ref": "ApiVersion" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`", "required": true, "type": "string" }, "apiVersionId": { "location": "query", "description": "Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" } }, "response": { "$ref": "ApiVersion" }, "id": "apigeeregistry.projects.locations.apis.versions.create", "path": "v1/{+parent}/versions", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "id": "apigeeregistry.projects.locations.apis.versions.setIamPolicy", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:setIamPolicy" } }, "resources": { "specs": { "methods": { "rollback": { "httpMethod": "POST", "description": "Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:rollback", "request": { "$ref": "RollbackApiSpecRequest" }, "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "description": "Required. The spec being rolled back." } }, "response": { "$ref": "ApiSpec" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.rollback", "path": "v1/{+name}:rollback", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "id": "apigeeregistry.projects.locations.apis.versions.specs.getIamPolicy", "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "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." }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "response": { "$ref": "Policy" }, "path": "v1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "create": { "path": "v1/{+parent}/specs", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", "request": { "$ref": "ApiSpec" }, "httpMethod": "POST", "description": "Creates a specified spec.", "parameters": { "apiSpecId": { "location": "query", "description": "Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" }, "parent": { "description": "Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ApiSpec" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.create" }, "get": { "id": "apigeeregistry.projects.locations.apis.versions.specs.get", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the spec to retrieve. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path" } }, "response": { "$ref": "ApiSpec" }, "description": "Returns a specified spec.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "tagRevision": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:tagRevision", "request": { "$ref": "TagApiSpecRevisionRequest" }, "description": "Adds a tag to a specified revision of a spec.", "httpMethod": "POST", "id": "apigeeregistry.projects.locations.apis.versions.specs.tagRevision", "parameters": { "name": { "description": "Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ApiSpec" }, "path": "v1/{+name}:tagRevision", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "testIamPermissions": { "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "listRevisions": { "httpMethod": "GET", "description": "Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:listRevisions", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "description": "Required. The name of the spec to list revisions for." }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of revisions to return per page.", "type": "integer" }, "pageToken": { "location": "query", "description": "The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.", "type": "string" } }, "response": { "$ref": "ListApiSpecRevisionsResponse" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.listRevisions", "path": "v1/{+name}:listRevisions", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getContents": { "path": "v1/{+name}:getContents", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getContents", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "description": "Required. The name of the spec whose contents should be retrieved. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", "required": true, "type": "string" } }, "response": { "$ref": "HttpBody" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.getContents" }, "setIamPolicy": { "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "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." } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.setIamPolicy" }, "delete": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", "httpMethod": "DELETE", "description": "Removes a specified spec, all revisions, and all child resources (e.g., artifacts).", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the spec to delete. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path" }, "force": { "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", "type": "boolean", "location": "query" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.delete" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", "description": "Returns matching specs.", "httpMethod": "GET", "id": "apigeeregistry.projects.locations.apis.versions.specs.list", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path" }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string", "location": "query" }, "pageToken": { "description": "A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "description": "The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string" } }, "response": { "$ref": "ListApiSpecsResponse" }, "path": "v1/{+parent}/specs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "patch": { "id": "apigeeregistry.projects.locations.apis.versions.specs.patch", "parameters": { "allowMissing": { "description": "If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.", "type": "boolean", "location": "query" }, "name": { "description": "Resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "response": { "$ref": "ApiSpec" }, "description": "Used to modify a specified spec.", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", "request": { "$ref": "ApiSpec" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "deleteRevision": { "id": "apigeeregistry.projects.locations.apis.versions.specs.deleteRevision", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "description": "Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`", "required": true, "type": "string" } }, "response": { "$ref": "ApiSpec" }, "description": "Deletes a revision of a spec.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:deleteRevision", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:deleteRevision" } }, "resources": { "artifacts": { "methods": { "list": { "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.list", "parameters": { "pageToken": { "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string" }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`" } }, "response": { "$ref": "ListArtifactsResponse" }, "description": "Returns matching artifacts.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/artifacts" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.get", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Artifact" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", "description": "Returns a specified artifact.", "httpMethod": "GET" }, "delete": { "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Removes a specified artifact.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.delete", "parameters": { "name": { "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Empty" } }, "setIamPolicy": { "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/artifacts", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", "location": "path" }, "artifactId": { "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string", "location": "query" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts", "request": { "$ref": "Artifact" }, "httpMethod": "POST", "description": "Creates a specified artifact." }, "replaceArtifact": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Resource name." } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.replaceArtifact", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", "request": { "$ref": "Artifact" }, "httpMethod": "PUT", "description": "Used to replace a specified artifact." }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getIamPolicy", "httpMethod": "GET", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path", "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.", "required": true, "type": "string" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getContents": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:getContents", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`" } }, "response": { "$ref": "HttpBody" }, "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.getContents", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getContents", "httpMethod": "GET", "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned)." }, "testIamPermissions": { "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.testIamPermissions", "parameters": { "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:testIamPermissions" } } } } }, "artifacts": { "methods": { "testIamPermissions": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "id": "apigeeregistry.projects.locations.apis.versions.artifacts.testIamPermissions", "parameters": { "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "path": "v1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "getContents": { "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getContents", "id": "apigeeregistry.projects.locations.apis.versions.artifacts.getContents", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`" } }, "response": { "$ref": "HttpBody" }, "path": "v1/{+name}:getContents", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "replaceArtifact": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}", "request": { "$ref": "Artifact" }, "description": "Used to replace a specified artifact.", "httpMethod": "PUT", "id": "apigeeregistry.projects.locations.apis.versions.artifacts.replaceArtifact", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Resource name.", "required": true, "type": "string" } }, "response": { "$ref": "Artifact" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "getIamPolicy": { "id": "apigeeregistry.projects.locations.apis.versions.artifacts.getIamPolicy", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path", "required": true, "type": "string" }, "options.requestedPolicyVersion": { "format": "int32", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "response": { "$ref": "Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy" }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "apigeeregistry.projects.locations.apis.versions.artifacts.setIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "path": "v1/{+resource}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "create": { "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path" }, "artifactId": { "location": "query", "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.versions.artifacts.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts", "request": { "$ref": "Artifact" }, "httpMethod": "POST", "description": "Creates a specified artifact.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/artifacts" }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}", "httpMethod": "GET", "description": "Returns a specified artifact.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.versions.artifacts.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "apigeeregistry.projects.locations.apis.versions.artifacts.delete", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Empty" }, "description": "Removes a specified artifact.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}" }, "list": { "path": "v1/{+parent}/artifacts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts", "description": "Returns matching artifacts.", "httpMethod": "GET", "id": "apigeeregistry.projects.locations.apis.versions.artifacts.list", "parameters": { "filter": { "location": "query", "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string" }, "parent": { "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", "type": "string" }, "pageSize": { "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "orderBy": { "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string", "location": "query" } }, "response": { "$ref": "ListArtifactsResponse" } } } } } }, "artifacts": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", "httpMethod": "GET", "description": "Returns a specified artifact.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.apis.artifacts.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Removes a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.apis.artifacts.delete" }, "list": { "path": "v1/{+parent}/artifacts", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Returns matching artifacts.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`" }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", "type": "string" }, "pageSize": { "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string", "location": "query" } }, "response": { "$ref": "ListArtifactsResponse" }, "id": "apigeeregistry.projects.locations.apis.artifacts.list" }, "getContents": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", "required": true, "type": "string" } }, "response": { "$ref": "HttpBody" }, "id": "apigeeregistry.projects.locations.apis.artifacts.getContents", "httpMethod": "GET", "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getContents", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:getContents" }, "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "id": "apigeeregistry.projects.locations.apis.artifacts.testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/artifacts", "id": "apigeeregistry.projects.locations.apis.artifacts.create", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`" }, "artifactId": { "location": "query", "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string" } }, "response": { "$ref": "Artifact" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts", "request": { "$ref": "Artifact" }, "description": "Creates a specified artifact.", "httpMethod": "POST" }, "setIamPolicy": { "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.apis.artifacts.setIamPolicy", "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" } }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "id": "apigeeregistry.projects.locations.apis.artifacts.getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Policy" }, "path": "v1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] }, "replaceArtifact": { "id": "apigeeregistry.projects.locations.apis.artifacts.replaceArtifact", "parameters": { "name": { "description": "Resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Artifact" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", "request": { "$ref": "Artifact" }, "description": "Used to replace a specified artifact.", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" } } } } }, "documents": { "methods": { "setIamPolicy": { "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/documents$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.documents.setIamPolicy" }, "getIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy", "id": "apigeeregistry.projects.locations.documents.getIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/documents$", "location": "path", "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.", "required": true, "type": "string" }, "options.requestedPolicyVersion": { "format": "int32", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "response": { "$ref": "Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET" }, "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/documents$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "id": "apigeeregistry.projects.locations.documents.testIamPermissions" } } }, "instances": { "methods": { "getIamPolicy": { "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "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." }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.instances.getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy", "httpMethod": "GET", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:getIamPolicy" }, "create": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/instances", "parameters": { "parent": { "description": "Required. Parent resource of the Instance, of the form: `projects/*/locations/*`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "instanceId": { "location": "query", "description": "Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.", "type": "string" } }, "response": { "$ref": "Operation" }, "id": "apigeeregistry.projects.locations.instances.create", "httpMethod": "POST", "description": "Provisions instance resources for the Registry.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "request": { "$ref": "Instance" } }, "setIamPolicy": { "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "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." } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.instances.setIamPolicy", "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:setIamPolicy" }, "testIamPermissions": { "id": "apigeeregistry.projects.locations.instances.testIamPermissions", "parameters": { "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:testIamPermissions" }, "delete": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the Instance to delete. Format: `projects/*/locations/*/instances/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path" } }, "response": { "$ref": "Operation" }, "id": "apigeeregistry.projects.locations.instances.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "DELETE", "description": "Deletes the Registry instance.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "description": "Required. The name of the Instance to retrieve. Format: `projects/*/locations/*/instances/*`.", "required": true, "type": "string" } }, "response": { "$ref": "Instance" }, "id": "apigeeregistry.projects.locations.instances.get", "httpMethod": "GET", "description": "Gets details of a single Instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}" } } }, "runtime": { "methods": { "setIamPolicy": { "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtime:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/runtime$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "id": "apigeeregistry.projects.locations.runtime.setIamPolicy" }, "getIamPolicy": { "id": "apigeeregistry.projects.locations.runtime.getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "location": "query", "format": "int32" }, "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/runtime$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtime:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy" }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtime:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "apigeeregistry.projects.locations.runtime.testIamPermissions", "parameters": { "resource": { "required": true, "type": "string", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/runtime$", "location": "path" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "path": "v1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ] } } }, "artifacts": { "methods": { "get": { "parameters": { "name": { "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.artifacts.get", "httpMethod": "GET", "description": "Returns a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "delete": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path" } }, "response": { "$ref": "Empty" }, "id": "apigeeregistry.projects.locations.artifacts.delete", "httpMethod": "DELETE", "description": "Removes a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/artifacts", "parameters": { "pageSize": { "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "orderBy": { "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", "type": "string" }, "filter": { "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "required": true, "type": "string" } }, "response": { "$ref": "ListArtifactsResponse" }, "id": "apigeeregistry.projects.locations.artifacts.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts", "httpMethod": "GET", "description": "Returns matching artifacts." }, "getContents": { "path": "v1/{+name}:getContents", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getContents", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", "required": true, "type": "string" } }, "response": { "$ref": "HttpBody" }, "id": "apigeeregistry.projects.locations.artifacts.getContents" }, "testIamPermissions": { "id": "apigeeregistry.projects.locations.artifacts.testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "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.", "required": true, "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:testIamPermissions" }, "create": { "path": "v1/{+parent}/artifacts", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Creates a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts", "request": { "$ref": "Artifact" }, "parameters": { "parent": { "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "artifactId": { "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", "type": "string", "location": "query" } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.artifacts.create" }, "setIamPolicy": { "id": "apigeeregistry.projects.locations.artifacts.setIamPolicy", "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "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." } }, "response": { "$ref": "Policy" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:setIamPolicy" }, "getIamPolicy": { "id": "apigeeregistry.projects.locations.artifacts.getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "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." } }, "response": { "$ref": "Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy" }, "replaceArtifact": { "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "location": "path", "description": "Resource name." } }, "response": { "$ref": "Artifact" }, "id": "apigeeregistry.projects.locations.artifacts.replaceArtifact", "httpMethod": "PUT", "description": "Used to replace a specified artifact.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", "request": { "$ref": "Artifact" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" } } } } } } } }, "servicePath": "", "canonicalName": "Apigee Registry", "ownerDomain": "google.com", "batchPath": "batch", "mtlsRootUrl": "https://apigeeregistry.mtls.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "title": "Apigee Registry API", "fullyEncodeReservedExpansion": true, "schemas": { "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); }", "type": "object", "properties": {}, "id": "Empty" }, "Api": { "id": "Api", "description": "A top-level description of an API. Produced by producers and are commitments to provide services.", "type": "object", "properties": { "displayName": { "description": "Human-meaningful name.", "type": "string" }, "recommendedVersion": { "description": "The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", "type": "string" }, "name": { "description": "Resource name.", "type": "string" }, "availability": { "description": "A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., \"NONE\", \"TESTING\", \"PREVIEW\", \"GENERAL\", \"DEPRECATED\", \"SHUTDOWN\".", "type": "string" }, "createTime": { "description": "Output only. Creation timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "recommendedDeployment": { "description": "The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`", "type": "string" }, "description": { "description": "A detailed description.", "type": "string" }, "labels": { "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", "type": "object", "additionalProperties": { "type": "string" } }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", "type": "object" }, "updateTime": { "description": "Output only. Last update timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "ListApiDeploymentRevisionsResponse": { "description": "Response message for ListApiDeploymentRevisionsResponse.", "type": "object", "properties": { "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "apiDeployments": { "items": { "$ref": "ApiDeployment" }, "description": "The revisions of the deployment.", "type": "array" } }, "id": "ListApiDeploymentRevisionsResponse" }, "Artifact": { "id": "Artifact", "description": "Artifacts of resources. Artifacts are unique (single-value) per resource and are used to store metadata that is too large or numerous to be stored directly on the resource. Since artifacts are stored separately from parent resources, they should generally be used for metadata that is needed infrequently, i.e., not for display in primary views of the resource but perhaps displayed or downloaded upon request. The `ListArtifacts` method allows artifacts to be quickly enumerated and checked for presence without downloading their (potentially-large) contents.", "type": "object", "properties": { "updateTime": { "description": "Output only. Last update timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", "type": "object" }, "sizeBytes": { "readOnly": true, "format": "int32", "description": "Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.", "type": "integer" }, "labels": { "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"registry.googleapis.com/\" and cannot be changed.", "type": "object", "additionalProperties": { "type": "string" } }, "mimeType": { "description": "A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible \"schema\" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\").", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Creation timestamp.", "type": "string" }, "hash": { "readOnly": true, "description": "Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.", "type": "string" }, "name": { "description": "Resource name.", "type": "string" }, "contents": { "description": "Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.", "type": "string", "format": "byte" } } }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" } }, "id": "SetIamPolicyRequest" }, "RollbackApiDeploymentRequest": { "id": "RollbackApiDeploymentRequest", "description": "Request message for RollbackApiDeployment.", "type": "object", "properties": { "revisionId": { "description": "Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: `c7cfa2a8`", "type": "string" } } }, "TagApiDeploymentRevisionRequest": { "id": "TagApiDeploymentRevisionRequest", "description": "Request message for TagApiDeploymentRevision.", "type": "object", "properties": { "tag": { "description": "Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`.", "type": "string" } } }, "ListArtifactsResponse": { "id": "ListArtifactsResponse", "description": "Response message for ListArtifacts.", "type": "object", "properties": { "artifacts": { "description": "The artifacts from the specified publisher.", "type": "array", "items": { "$ref": "Artifact" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array" } }, "id": "TestIamPermissionsResponse" }, "HttpBody": { "id": "HttpBody", "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "type": "object", "properties": { "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "extensions": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "type": "array" }, "data": { "format": "byte", "description": "The HTTP request/response body as raw binary.", "type": "string" } } }, "Config": { "id": "Config", "description": "Available configurations to provision an Instance.", "type": "object", "properties": { "location": { "readOnly": true, "description": "Output only. The GCP location where the Instance resides.", "type": "string" }, "cmekKeyName": { "description": "Required. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the `location` must match InstanceConfig.location.", "type": "string" } } }, "ListApiVersionsResponse": { "description": "Response message for ListApiVersions.", "type": "object", "properties": { "apiVersions": { "description": "The versions from the specified publisher.", "type": "array", "items": { "$ref": "ApiVersion" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "ListApiVersionsResponse" }, "Status": { "id": "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).", "type": "object", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "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" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } } }, "ListApiSpecRevisionsResponse": { "id": "ListApiSpecRevisionsResponse", "description": "Response message for ListApiSpecRevisionsResponse.", "type": "object", "properties": { "apiSpecs": { "description": "The revisions of the spec.", "type": "array", "items": { "$ref": "ApiSpec" } }, "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "ApiDeployment": { "description": "Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.", "type": "object", "properties": { "name": { "description": "Resource name.", "type": "string" }, "accessGuidance": { "description": "Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.", "type": "string" }, "revisionId": { "description": "Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.", "type": "string", "readOnly": true }, "externalChannelUri": { "description": "The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.", "type": "string" }, "description": { "description": "A detailed description.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Creation timestamp; when the deployment resource was created.", "type": "string" }, "displayName": { "description": "Human-meaningful name.", "type": "string" }, "intendedAudience": { "description": "Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.", "type": "string" }, "apiSpecRevision": { "description": "The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}`", "type": "string" }, "revisionUpdateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Last update timestamp: when the represented revision was last modified.", "type": "string" }, "revisionCreateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Revision creation timestamp; when the represented revision was created.", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", "type": "object" }, "endpointUri": { "description": "The address where the deployment is serving. Changes to this value will update the revision.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", "type": "object" } }, "id": "ApiDeployment" }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "id": "Expr" }, "Policy": { "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object", "properties": { "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string" }, "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "bindings": { "items": { "$ref": "Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array" } } }, "Instance": { "id": "Instance", "description": "An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.", "type": "object", "properties": { "name": { "description": "Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported.", "type": "string" }, "createTime": { "description": "Output only. Creation timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "config": { "$ref": "Config", "description": "Required. Config of the Instance." }, "stateMessage": { "description": "Output only. Extra information of Instance.State if the state is `FAILED`.", "type": "string", "readOnly": true }, "build": { "readOnly": true, "$ref": "Build", "description": "Output only. Build info of the Instance if it's in `ACTIVE` state." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Last update timestamp.", "type": "string" }, "state": { "description": "Output only. The current state of the Instance.", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The Instance has not been initialized or has been deleted.", "The Instance is being created.", "The Instance has been created and is ready for use.", "The Instance is being updated.", "The Instance is being deleted.", "The Instance encountered an error during a state change." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "INACTIVE", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "cancellationRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "apiVersion": { "description": "API version used to start the operation.", "type": "string" }, "statusMessage": { "description": "Human-readable status of the operation, if any.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "verb": { "description": "Name of the verb executed by the operation.", "type": "string" }, "target": { "description": "Server-defined resource path for the target of the operation.", "type": "string" } } }, "ListApiDeploymentsResponse": { "id": "ListApiDeploymentsResponse", "description": "Response message for ListApiDeployments.", "type": "object", "properties": { "apiDeployments": { "items": { "$ref": "ApiDeployment" }, "description": "The deployments from the specified publisher.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "ApiSpec": { "description": "Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.", "type": "object", "properties": { "revisionUpdateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Last update timestamp: when the represented revision was last modified.", "type": "string" }, "revisionCreateTime": { "description": "Output only. Revision creation timestamp; when the represented revision was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", "type": "object" }, "sourceUri": { "description": "The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", "type": "object" }, "description": { "description": "A detailed description.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Creation timestamp; when the spec resource was created.", "type": "string" }, "hash": { "description": "Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.", "type": "string", "readOnly": true }, "filename": { "description": "A possibly-hierarchical name used to refer to the spec from other specs.", "type": "string" }, "revisionId": { "readOnly": true, "description": "Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.", "type": "string" }, "sizeBytes": { "readOnly": true, "format": "int32", "description": "Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.", "type": "integer" }, "mimeType": { "description": "A style (format) descriptor for this spec that is specified as a [Media Type](https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\").", "type": "string" }, "name": { "description": "Resource name.", "type": "string" }, "contents": { "format": "byte", "description": "Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.", "type": "string" } }, "id": "ApiSpec" }, "TagApiSpecRevisionRequest": { "id": "TagApiSpecRevisionRequest", "description": "Request message for TagApiSpecRevision.", "type": "object", "properties": { "tag": { "description": "Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`.", "type": "string" } } }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "array" } }, "id": "TestIamPermissionsRequest" }, "Build": { "id": "Build", "description": "Build information of the Instance if it's in `ACTIVE` state.", "type": "object", "properties": { "repo": { "readOnly": true, "description": "Output only. Path of the open source repository: github.com/apigee/registry.", "type": "string" }, "commitId": { "readOnly": true, "description": "Output only. Commit ID of the latest commit in the build.", "type": "string" }, "commitTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Commit time of the latest commit in the build.", "type": "string" } } }, "ListApiSpecsResponse": { "id": "ListApiSpecsResponse", "description": "Response message for ListApiSpecs.", "type": "object", "properties": { "apiSpecs": { "items": { "$ref": "ApiSpec" }, "description": "The specs from the specified publisher.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "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.", "type": "array", "items": { "$ref": "Operation" } } } }, "RollbackApiSpecRequest": { "description": "Request message for RollbackApiSpec.", "type": "object", "properties": { "revisionId": { "description": "Required. The revision ID to roll back to. It must be a revision of the same spec. Example: `c7cfa2a8`", "type": "string" } }, "id": "RollbackApiSpecRequest" }, "ListApisResponse": { "id": "ListApisResponse", "description": "Response message for ListApis.", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "apis": { "description": "The APIs from the specified publisher.", "type": "array", "items": { "$ref": "Api" } } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", "type": "string" }, "members": { "items": { "type": "string" }, "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`. * `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.", "type": "array" }, "condition": { "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).", "$ref": "Expr" } }, "id": "Binding" }, "ApiVersion": { "description": "Describes a particular version of an API. ApiVersions are what consumers actually use.", "type": "object", "properties": { "description": { "description": "A detailed description.", "type": "string" }, "primarySpec": { "description": "The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}", "type": "string" }, "displayName": { "description": "Human-meaningful name.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Creation timestamp.", "type": "string" }, "name": { "description": "Resource name.", "type": "string" }, "updateTime": { "description": "Output only. Last update timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "state": { "description": "A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., \"CONCEPT\", \"DESIGN\", \"DEVELOPMENT\", \"STAGING\", \"PRODUCTION\", \"DEPRECATED\", \"RETIRED\".", "type": "string" }, "annotations": { "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", "type": "object" } }, "id": "ApiVersion" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "response": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "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" }, "metadata": { "additionalProperties": { "type": "any", "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" } }, "id": "Operation" } }, "parameters": { "callback": { "location": "query", "type": "string", "description": "JSONP" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "alt": { "location": "query", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "type": "string", "enum": [ "json", "media", "proto" ] }, "quotaUser": { "type": "string", "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" }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "key": { "type": "string", "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" }, "prettyPrint": { "location": "query", "default": "true", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } }, "id": "apigeeregistry:v1", "revision": "20231204", "name": "apigeeregistry", "basePath": "", "rootUrl": "https://apigeeregistry.googleapis.com/", "discoveryVersion": "v1", "version": "v1", "ownerName": "Google", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "kind": "discovery#restDescription", "description": "", "baseUrl": "https://apigeeregistry.googleapis.com/", "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", "protocol": "rest", "version_module": true }