Method: projects.locations.apis.versions.operations.patch

Update an operation in an API version. The following fields in the ApiOperation resource can be updated:

  • [details.description][ApiOperation.details.description]
  • [details.documentation][ApiOperation.details.documentation]
  • [details.http_operation.path][ApiOperation.details.http_operation.path.path]
  • [details.http_operation.method][ApiOperation.details.http_operation.method]
  • [details.deprecated][ApiOperation.details.deprecated]
  • attributes

The updateMask should be used to specify the fields being updated.

An operation can be updated only if the operation was created via operations.create API. If the operation was created by parsing the spec, then it can be edited by updating the spec.

HTTP request

PATCH https://apihub.googleapis.com/v1/{apiOperation.name=projects/*/locations/*/apis/*/versions/*/operations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
apiOperation.name

string

Identifier. The name of the operation.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of ApiOperation.

Response body

If successful, the response body contains an instance of ApiOperation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the name resource:

  • apihub.apiOperations.update

For more information, see the IAM documentation.