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

Attributes

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

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields

Link to this section Types

t()

t() :: %GoogleApi.Discovery.V1.Model.RestDescription{
  auth: GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t(),
  basePath: any(),
  baseUrl: any(),
  batchPath: any(),
  canonicalName: any(),
  description: any(),
  discoveryVersion: any(),
  documentationLink: any(),
  etag: any(),
  exponentialBackoffDefault: any(),
  features: [any()],
  icons: GoogleApi.Discovery.V1.Model.DirectoryListIcons.t(),
  id: any(),
  kind: any(),
  labels: [any()],
  methods: map(),
  name: any(),
  ownerDomain: any(),
  ownerName: any(),
  packagePath: any(),
  parameters: map(),
  protocol: any(),
  resources: map(),
  revision: any(),
  rootUrl: any(),
  schemas: map(),
  servicePath: any(),
  title: any(),
  version: any(),
  version_module: any()
}

Link to this section Functions

decode(value, options)

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.