package gapi-ocaml

  1. Overview
  2. Docs
A simple OCaml client for Google Services

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (2)

Authors

  1. A
    Alessandro Strada

Maintainers

  1. A
    Alessandro Strada <alessandro.strada@gmail.com>

Sources

v0.4.7.tar.gz
sha256=3a9e7ba4446b90f842c10dc2e49211c394c9f012715da01bb0b80baccabb41bb
md5=27919a0188772392e9b74bfd95fbaaa1

doc/gapi-ocaml/GapiDiscoveryV1Model/RestDescription/index.html

Module GapiDiscoveryV1Model.RestDescriptionSource

Sourcemodule Auth : sig ... end
Sourcemodule Icons : sig ... end
Sourcemodule Endpoints : sig ... end
Sourcetype t = {
  1. protocol : string;
    (*

    The protocol described by this document.

    *)
  2. kind : string;
    (*

    The kind for this response.

    *)
  3. ownerName : string;
    (*

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

    *)
  4. rootUrl : string;
    (*

    The root URL under which all API services live.

    *)
  5. endpoints : Endpoints.t list;
    (*

    A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.

    *)
  6. labels : string list;
    (*

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

    *)
  7. packagePath : string;
    (*

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

    *)
  8. revision : string;
    (*

    The version of this API.

    *)
  9. id : string;
    (*

    The ID of this API.

    *)
  10. basePath : string;
    (*

    [DEPRECATED] The base path for REST requests.

    *)
  11. description : string;
    (*

    The description of this API.

    *)
  12. name : string;
    (*

    The name of this API.

    *)
  13. baseUrl : string;
    (*

    [DEPRECATED] The base URL for REST requests.

    *)
  14. canonicalName : string;
    (*

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

    *)
  15. discoveryVersion : string;
    (*

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

    *)
  16. schemas : (string * JsonSchema.t) list;
    (*

    The schemas for this API.

    *)
  17. batchPath : string;
    (*

    The path for REST batch requests.

    *)
  18. version_module : bool;
  19. icons : Icons.t;
    (*

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

    *)
  20. etag : string;
    (*

    The ETag for this response.

    *)
  21. version : string;
    (*

    The version of this API.

    *)
  22. servicePath : string;
    (*

    The base path for all REST requests.

    *)
  23. resources : (string * RestResource.t) list;
    (*

    The resources in this API.

    *)
  24. parameters : (string * JsonSchema.t) list;
    (*

    Common parameters that apply across all apis.

    *)
  25. methods : (string * RestMethod.t) list;
    (*

    API-level methods for this API.

    *)
  26. exponentialBackoffDefault : bool;
    (*

    Enable exponential backoff for suitable methods in the generated clients.

    *)
  27. 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.

    *)
  28. features : string list;
    (*

    A list of supported features for this API.

    *)
  29. auth : Auth.t;
    (*

    Authentication information.

    *)
  30. title : string;
    (*

    The title of this API.

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