package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Response : sig ... end
module Request : sig ... end
module MediaUpload : sig ... end
type t = {
  1. description : string;
    (*

    Description of this method.

    *)
  2. etagRequired : bool;
    (*

    Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

    *)
  3. httpMethod : string;
    (*

    HTTP method used by this method.

    *)
  4. id : string;
    (*

    A unique ID for this method. This property can be used to match methods between different versions of Discovery.

    *)
  5. mediaUpload : MediaUpload.t;
    (*

    Media upload parameters.

    *)
  6. parameterOrder : string list;
    (*

    Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.

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

    Details for all parameters in this method.

    *)
  8. path : string;
    (*

    The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

    *)
  9. request : Request.t;
    (*

    The schema for the request.

    *)
  10. response : Response.t;
    (*

    The schema for the response.

    *)
  11. scopes : string list;
    (*

    OAuth 2.0 scopes applicable to this method.

    *)
  12. supportsMediaDownload : bool;
    (*

    Whether this method supports media downloads.

    *)
  13. supportsMediaUpload : bool;
    (*

    Whether this method supports media uploads.

    *)
  14. supportsSubscription : bool;
    (*

    Whether this method supports subscriptions.

    *)
  15. useMediaDownloadService : bool;
    (*

    Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

    *)
}
val description : (t, string) GapiLens.t
val etagRequired : (t, bool) GapiLens.t
val httpMethod : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val mediaUpload : (t, MediaUpload.t) GapiLens.t
val parameterOrder : (t, string list) GapiLens.t
val parameters : (t, (string * JsonSchema.t) list) GapiLens.t
val path : (t, string) GapiLens.t
val request : (t, Request.t) GapiLens.t
val response : (t, Response.t) GapiLens.t
val scopes : (t, string list) GapiLens.t
val supportsMediaDownload : (t, bool) GapiLens.t
val supportsMediaUpload : (t, bool) GapiLens.t
val supportsSubscription : (t, bool) GapiLens.t
val useMediaDownloadService : (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