Up  Next

Module GapiDiscoveryV1Model.JsonSchema

module JsonSchema: sig .. end
module Variant: sig .. end
module Annotations: sig .. end
type t = {
   _ref : string; (*
A reference to another schema. The value of this property is the "id" of another schema.
*)
   additionalProperties : t option; (*
If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
*)
   annotations : Annotations.t; (*
Additional information about this property.
*)
   default : string; (*
The default value of this property (if one exists).
*)
   description : string; (*
A description of this object.
*)
   enum : string list; (*
Values this parameter may take (if it is an enum).
*)
   enumDescriptions : string list; (*
The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
*)
   format : string; (*
An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
*)
   id : string; (*
Unique identifier for this schema.
*)
   items : t option; (*
If this is a schema for an array, this property is the schema for each element in the array.
*)
   location : string; (*
Whether this parameter goes in the query or the path for REST requests.
*)
   maximum : string; (*
The maximum value of this parameter.
*)
   minimum : string; (*
The minimum value of this parameter.
*)
   pattern : string; (*
The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
*)
   properties : (string * t) list; (*
If this is a schema for an object, list the schema for each property of this object.
*)
   readOnly : bool; (*
The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
*)
   repeated : bool; (*
Whether this parameter may appear multiple times.
*)
   required : bool; (*
Whether the parameter is required.
*)
   _type : string; (*
The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
*)
   variant : Variant.t; (*
In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
*)
} 
val _ref : (t, string) GapiLens.t
val additionalProperties : (t, t option)
       GapiLens.t
val annotations : (t,
        Annotations.t)
       GapiLens.t
val default : (t, string) GapiLens.t
val description : (t, string) GapiLens.t
val enum : (t, string list) GapiLens.t
val enumDescriptions : (t, string list) GapiLens.t
val format : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val items : (t, t option)
       GapiLens.t
val location : (t, string) GapiLens.t
val maximum : (t, string) GapiLens.t
val minimum : (t, string) GapiLens.t
val pattern : (t, string) GapiLens.t
val properties : (t,
        (string * t) list)
       GapiLens.t
val readOnly : (t, bool) GapiLens.t
val repeated : (t, bool) GapiLens.t
val required : (t, bool) GapiLens.t
val _type : (t, string) GapiLens.t
val variant : (t,
        Variant.t)
       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