google_api_discovery v0.3.0 GoogleApi.Discovery.V1.Model.RestDescription View Source

Attributes

  • auth (GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t): Authentication information. Defaults to nil.
  • basePath (String.t): [DEPRECATED] The base path for REST requests. Defaults to nil.
  • baseUrl (String.t): [DEPRECATED] The base URL for REST requests. Defaults to nil.
  • batchPath (String.t): The path for REST batch requests. Defaults to nil.
  • canonicalName (String.t): Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. Defaults to nil.
  • description (String.t): The description of this API. Defaults to nil.
  • discoveryVersion (String.t): Indicate the version of the Discovery API used to generate this doc. Defaults to v1.
  • documentationLink (String.t): A link to human readable documentation for the API. Defaults to nil.
  • etag (String.t): The ETag for this response. Defaults to nil.
  • exponentialBackoffDefault (boolean()): Enable exponential backoff for suitable methods in the generated clients. Defaults to nil.
  • features (list(String.t)): A list of supported features for this API. Defaults to nil.
  • icons (GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t): Links to 16x16 and 32x32 icons representing the API. Defaults to nil.
  • id (String.t): The ID of this API. Defaults to nil.
  • kind (String.t): The kind for this response. Defaults to discovery#restDescription.
  • labels (list(String.t)): Labels for the status of this API, such as labs or deprecated. Defaults to nil.
  • methods (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}): API-level methods for this API. Defaults to nil.
  • name (String.t): The name of this API. Defaults to nil.
  • ownerDomain (String.t): 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. Defaults to nil.
  • ownerName (String.t): The name of the owner of this API. See ownerDomain. Defaults to nil.
  • packagePath (String.t): The package of the owner of this API. See ownerDomain. Defaults to nil.
  • parameters (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): Common parameters that apply across all apis. Defaults to nil.
  • protocol (String.t): The protocol described by this document. Defaults to rest.
  • resources (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}): The resources in this API. Defaults to nil.
  • revision (String.t): The version of this API. Defaults to nil.
  • rootUrl (String.t): The root URL under which all API services live. Defaults to nil.
  • schemas (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): The schemas for this API. Defaults to nil.
  • servicePath (String.t): The base path for all REST requests. Defaults to nil.
  • title (String.t): The title of this API. Defaults to nil.
  • version (String.t): The version of this API. Defaults to nil.
  • version_module (boolean()): Defaults to nil.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Discovery.V1.Model.RestDescription{
  auth: GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t(),
  basePath: String.t(),
  baseUrl: String.t(),
  batchPath: String.t(),
  canonicalName: String.t(),
  description: String.t(),
  discoveryVersion: String.t(),
  documentationLink: String.t(),
  etag: String.t(),
  exponentialBackoffDefault: boolean(),
  features: [String.t()],
  icons: GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t(),
  id: String.t(),
  kind: String.t(),
  labels: [String.t()],
  methods: %{
    optional(String.t()) => GoogleApi.Discovery.V1.Model.RestMethod.t()
  },
  name: String.t(),
  ownerDomain: String.t(),
  ownerName: String.t(),
  packagePath: String.t(),
  parameters: %{
    optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()
  },
  protocol: String.t(),
  resources: %{
    optional(String.t()) => GoogleApi.Discovery.V1.Model.RestResource.t()
  },
  revision: String.t(),
  rootUrl: String.t(),
  schemas: %{
    optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()
  },
  servicePath: String.t(),
  title: String.t(),
  version: String.t(),
  version_module: boolean()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.