Method: projects.locations.apis.versions.specs.list

List specs corresponding to a particular API resource.

HTTP request

GET https://apihub.googleapis.com/v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of specs. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Query parameters

Parameters
filter

string

Optional. An expression that filters the list of Specs.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are not case sensitive.

The following fields in the Spec are eligible for filtering:

  • displayName - The display name of the Spec. Allowed comparison operators: =.
  • createTime - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.
  • specType.enum_values.values.id - The allowed value id of the specType attribute associated with the Spec. Allowed comparison operators: :.
  • lintResponse.json_values.values - The json value of the lintResponse attribute associated with the Spec. Allowed comparison operators: :.

Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

Here are a few examples:

  • specType.enum_values.values.id: rest-id - The filter string specifies that the id of the allowed value associated with the specType attribute is rest-id.
  • specType.enum_values.values.id: grpc-id AND createTime < \"2021-08-15T14:50:00Z\" AND createTime > \"2021-08-10T12:00:00Z\" - The id of the allowed value associated with the specType attribute is grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • specType.enum_values.values.id: rest-id OR specType.enum_values.values.id: grpc-id
  • The id of the allowed value associated with the specType attribute is rest-id or grpc-id.
pageSize

integer

Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous specs.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to specs.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The specs.list method's response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "specs": [
    {
      object (Spec)
    }
  ],
  "nextPageToken": string
}
Fields
specs[]

object (Spec)

The specs corresponding to an API. Only following field will be populated in the response: name, displayName, specType.enum_values.values.id and lintResponse.json_values.values.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apihub.specs.list

For more information, see the IAM documentation.