Module GapiDiscoveryV1Model.RestDescription

module Icons : sig ... end
module Auth : sig ... end
type t = {
auth : Auth.t;

Authentication information.

basePath : string;

[DEPRECATED] The base path for REST requests.

baseUrl : string;

[DEPRECATED] The base URL for REST requests.

batchPath : string;

The path for REST batch requests.

canonicalName : string;

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

description : string;

The description of this API.

discoveryVersion : string;

Indicate the version of the Discovery API used to generate this doc.

etag : string;

The ETag for this response.

exponentialBackoffDefault : bool;

Enable exponential backoff for suitable methods in the generated clients.

features : string list;

A list of supported features for this API.

icons : Icons.t;

Links to 16x16 and 32x32 icons representing the API.

id : string;

The ID of this API.

kind : string;

The kind for this response.

labels : string list;

Labels for the status of this API, such as labs or deprecated.

methods : (string * RestMethod.t) list;

API-level methods for this API.

name : string;

The name of this API.

ownerDomain : string;

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 : string;

The name of the owner of this API. See ownerDomain.

packagePath : string;

The package of the owner of this API. See ownerDomain.

parameters : (string * JsonSchema.t) list;

Common parameters that apply across all apis.

protocol : string;

The protocol described by this document.

resources : (string * RestResource.t) list;

The resources in this API.

revision : string;

The version of this API.

rootUrl : string;

The root URL under which all API services live.

schemas : (string * JsonSchema.t) list;

The schemas for this API.

servicePath : string;

The base path for all REST requests.

title : string;

The title of this API.

version : string;

The version of this API.

version_module : bool;
}
val auth : (tAuth.t) GapiLens.t
val basePath : (t, string) GapiLens.t
val baseUrl : (t, string) GapiLens.t
val batchPath : (t, string) GapiLens.t
val canonicalName : (t, string) GapiLens.t
val description : (t, string) GapiLens.t
val discoveryVersion : (t, string) GapiLens.t
val etag : (t, string) GapiLens.t
val exponentialBackoffDefault : (t, bool) GapiLens.t
val features : (tstring list) GapiLens.t
val icons : (tIcons.t) GapiLens.t
val id : (t, string) GapiLens.t
val kind : (t, string) GapiLens.t
val labels : (tstring list) GapiLens.t
val methods : (t(string * RestMethod.t) list) GapiLens.t
val name : (t, string) GapiLens.t
val ownerDomain : (t, string) GapiLens.t
val ownerName : (t, string) GapiLens.t
val packagePath : (t, string) GapiLens.t
val parameters : (t(string * JsonSchema.t) list) GapiLens.t
val protocol : (t, string) GapiLens.t
val resources : (t(string * RestResource.t) list) GapiLens.t
val revision : (t, string) GapiLens.t
val rootUrl : (t, string) GapiLens.t
val schemas : (t(string * JsonSchema.t) list) GapiLens.t
val servicePath : (t, string) GapiLens.t
val title : (t, string) GapiLens.t
val version : (t, string) GapiLens.t
val version_module : (t, bool) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t