REST Resource: projects.locations.apis.versions.operations

Resource: ApiOperation

Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec.

JSON representation 
{
  "name": string,
  "spec": string,
  "details": {
    object (OperationDetails)
  },
  "createTime": string,
  "updateTime": string,
  "attributes": {
    string: {
      object (AttributeValues)
    },
    ...
  }
}
Fields
name

string

Identifier. The name of the operation.

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

string

Output only. The name of the spec from where the operation was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
details

object (OperationDetails)

Output only. Operation details.
createTime

string (Timestamp format)

Output only. The time at which the operation was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time at which the operation was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
attributes

map (key: string, value: object (AttributeValues))

Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

OperationDetails

The operation details parsed from the spec.

JSON representation 
{
  "description": string,
  "documentation": {
    object (Documentation)
  },
  "deprecated": boolean,

  // Union field operation can be only one of the following:
  "httpOperation": {
    object (HttpOperation)
  }
  // End of list of possible types for union field operation.
}
Fields
description

string

Output only. Description of the operation behavior. For OpenAPI spec, this will map to operation.description in the spec, in case description is empty, operation.summary will be used.
documentation

object (Documentation)

Output only. Additional external documentation for this operation. For OpenAPI spec, this will map to operation.documentation in the spec.
deprecated

boolean

Output only. For OpenAPI spec, this will be set if operation.deprecatedis marked as true in the spec.

Union field operation.

operation can be only one of the following:
httpOperation

object (HttpOperation)

The HTTP Operation.

HttpOperation

The HTTP Operation.

JSON representation 
{
  "path": {
    object (Path)
  },
  "method": enum (Method)
}
Fields
path

object (Path)

Output only. The path details for the Operation.
method

enum (Method)

Output only. Operation method

Path

The path details derived from the spec.

JSON representation 
{
  "path": string,
  "description": string
}
Fields
path

string

Output only. Complete path relative to server endpoint.
description

string

Output only. A short description for the path applicable to all operations.

Method

Enumeration of Method types.

Enums
METHOD_UNSPECIFIED Method unspecified.
GET Get Operation type.
PUT Put Operation type.
POST Post Operation type.
DELETE Delete Operation type.
OPTIONS Options Operation type.
HEAD Head Operation type.
PATCH Patch Operation type.
TRACE Trace Operation type.

Methods

get

 Get details about a particular operation in API version.

list

 List operations in an API version.