google_api_discovery v0.1.0 GoogleApi.Discovery.V1.Api.Apis View Source
API calls for all endpoints tagged Apis
.
Link to this section Summary
Functions
Retrieve the description of a particular version of an api
Retrieve the list of APIs supported at this endpoint
Link to this section Functions
Link to this function
discovery_apis_get_rest(connection, api, version, opts \\ [])
View Source
discovery_apis_get_rest(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Discovery.V1.Model.RestDescription.t()} | {:error, Tesla.Env.t()}
Retrieve the description of a particular version of an api.
Parameters
- connection (GoogleApi.Discovery.V1.Connection): Connection to server
- api (String.t): The name of the API.
- version (String.t): The version of the API.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Discovery.V1.Model.RestDescription{}} on success {:error, info} on failure
Link to this function
discovery_apis_list(connection, opts \\ [])
View Source
discovery_apis_list(Tesla.Env.client(), keyword()) :: {:ok, GoogleApi.Discovery.V1.Model.DirectoryList.t()} | {:error, Tesla.Env.t()}
Retrieve the list of APIs supported at this endpoint.
Parameters
- connection (GoogleApi.Discovery.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :name (String.t): Only include APIs with the given name.
- :preferred (boolean()): Return only the preferred version of an API.
Returns
{:ok, %GoogleApi.Discovery.V1.Model.DirectoryList{}} on success {:error, info} on failure