View Source GoogleApi.Discovery.V1.Model.RestDescription (google_api_discovery v0.16.0)
Attributes
-
auth
(type:GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t
, default:nil
) - Authentication information. -
basePath
(type:String.t
, default:nil
) - [DEPRECATED] The base path for REST requests. -
baseUrl
(type:String.t
, default:nil
) - [DEPRECATED] The base URL for REST requests. -
batchPath
(type:String.t
, default:nil
) - The path for REST batch requests. -
canonicalName
(type:String.t
, default:nil
) - Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. -
description
(type:String.t
, default:nil
) - The description of this API. -
discoveryVersion
(type:String.t
, default:v1
) - Indicate the version of the Discovery API used to generate this doc. -
documentationLink
(type:String.t
, default:nil
) - A link to human readable documentation for the API. -
endpoints
(type:list(GoogleApi.Discovery.V1.Model.RestDescriptionEndpoints.t)
, default:nil
) - A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status. -
etag
(type:String.t
, default:nil
) - The ETag for this response. -
exponentialBackoffDefault
(type:boolean()
, default:nil
) - Enable exponential backoff for suitable methods in the generated clients. -
features
(type:list(String.t)
, default:nil
) - A list of supported features for this API. -
icons
(type:GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t
, default:nil
) - Links to 16x16 and 32x32 icons representing the API. -
id
(type:String.t
, default:nil
) - The ID of this API. -
kind
(type:String.t
, default:discovery#restDescription
) - The kind for this response. -
labels
(type:list(String.t)
, default:nil
) - Labels for the status of this API, such as labs or deprecated. -
methods
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}
, default:nil
) - API-level methods for this API. -
name
(type:String.t
, default:nil
) - The name of this API. -
ownerDomain
(type:String.t
, default:nil
) - The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. -
ownerName
(type:String.t
, default:nil
) - The name of the owner of this API. See ownerDomain. -
packagePath
(type:String.t
, default:nil
) - The package of the owner of this API. See ownerDomain. -
parameters
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}
, default:nil
) - Common parameters that apply across all apis. -
protocol
(type:String.t
, default:rest
) - The protocol described by this document. -
resources
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}
, default:nil
) - The resources in this API. -
revision
(type:String.t
, default:nil
) - The version of this API. -
rootUrl
(type:String.t
, default:nil
) - The root URL under which all API services live. -
schemas
(type:%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}
, default:nil
) - The schemas for this API. -
servicePath
(type:String.t
, default:nil
) - The base path for all REST requests. -
title
(type:String.t
, default:nil
) - The title of this API. -
version
(type:String.t
, default:nil
) - The version of this API. -
version_module
(type:boolean()
, default:nil
) -
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Discovery.V1.Model.RestDescription{ auth: GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t() | nil, basePath: String.t() | nil, baseUrl: String.t() | nil, batchPath: String.t() | nil, canonicalName: String.t() | nil, description: String.t() | nil, discoveryVersion: String.t() | nil, documentationLink: String.t() | nil, endpoints: [GoogleApi.Discovery.V1.Model.RestDescriptionEndpoints.t()] | nil, etag: String.t() | nil, exponentialBackoffDefault: boolean() | nil, features: [String.t()] | nil, icons: GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t() | nil, id: String.t() | nil, kind: String.t() | nil, labels: [String.t()] | nil, methods: %{optional(String.t()) => GoogleApi.Discovery.V1.Model.RestMethod.t()} | nil, name: String.t() | nil, ownerDomain: String.t() | nil, ownerName: String.t() | nil, packagePath: String.t() | nil, parameters: %{optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()} | nil, protocol: String.t() | nil, resources: %{optional(String.t()) => GoogleApi.Discovery.V1.Model.RestResource.t()} | nil, revision: String.t() | nil, rootUrl: String.t() | nil, schemas: %{optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()} | nil, servicePath: String.t() | nil, title: String.t() | nil, version: String.t() | nil, version_module: boolean() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.