View Source GoogleApi.Discovery.V1.Api.Apis (google_api_discovery v0.16.0)

API calls for all endpoints tagged Apis.

Summary

Functions

discovery_apis_get_rest(connection, api, version, optional_params \\ [], opts \\ [])

Retrieve the description of a particular version of an api.

discovery_apis_list(connection, optional_params \\ [], opts \\ [])

Retrieve the list of APIs supported at this endpoint.

Functions

Link to this function

discovery_apis_get_rest(connection, api, version, optional_params \\ [], opts \\ [])

View Source 
@spec discovery_apis_get_rest(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Discovery.V1.Model.RestDescription.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve the description of a particular version of an api.

Parameters

  • connection (type: GoogleApi.Discovery.V1.Connection.t) - Connection to server
  • api (type: String.t) - The name of the API.
  • version (type: String.t) - The version of the API.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Discovery.V1.Model.RestDescription{}} on success
  • {:error, info} on failure
Link to this function

discovery_apis_list(connection, optional_params \\ [], opts \\ [])

View Source 
@spec discovery_apis_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Discovery.V1.Model.DirectoryList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve the list of APIs supported at this endpoint.

Parameters

  • connection (type: GoogleApi.Discovery.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :name (type: String.t) - Only include APIs with the given name.
    • :preferred (type: boolean()) - Return only the preferred version of an API.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Discovery.V1.Model.DirectoryList{}} on success
  • {:error, info} on failure