package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GapiDiscoveryV1Model.JsonSchemaSource

Sourcemodule Annotations : sig ... end
Sourcemodule Variant : sig ... end
Sourcetype t = {
  1. 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

    *)
  2. maximum : string;
    (*

    The maximum value of this parameter.

    *)
  3. minimum : string;
    (*

    The minimum value of this parameter.

    *)
  4. enumDeprecated : bool list;
    (*

    The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array.

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

    *)
  6. repeated : bool;
    (*

    Whether this parameter may appear multiple times.

    *)
  7. _ref : string;
    (*

    A reference to another schema. The value of this property is the "id" of another schema.

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

    *)
  9. _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

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

    *)
  11. required : bool;
    (*

    Whether the parameter is required.

    *)
  12. items : t option;
    (*

    If this is a schema for an array, this property is the schema for each element in the array.

    *)
  13. annotations : Annotations.t;
    (*

    Additional information about this property.

    *)
  14. enumDescriptions : string list;
    (*

    The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

    *)
  15. location : string;
    (*

    Whether this parameter goes in the query or the path for REST requests.

    *)
  16. default : string;
    (*

    The default value of this property (if one exists).

    *)
  17. description : string;
    (*

    A description of this object.

    *)
  18. deprecated : bool;
    (*

    Whether the parameter is deprecated.

    *)
  19. properties : (string * t) list;
    (*

    If this is a schema for an object, list the schema for each property of this object.

    *)
  20. enum : string list;
    (*

    Values this parameter may take (if it is an enum).

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

    *)
  22. id : string;
    (*

    Unique identifier for this schema.

    *)
}
Sourceval format : (t, string) GapiLens.t
Sourceval maximum : (t, string) GapiLens.t
Sourceval minimum : (t, string) GapiLens.t
Sourceval enumDeprecated : (t, bool list) GapiLens.t
Sourceval pattern : (t, string) GapiLens.t
Sourceval repeated : (t, bool) GapiLens.t
Sourceval _ref : (t, string) GapiLens.t
Sourceval readOnly : (t, bool) GapiLens.t
Sourceval _type : (t, string) GapiLens.t
Sourceval variant : (t, Variant.t) GapiLens.t
Sourceval required : (t, bool) GapiLens.t
Sourceval items : (t, t option) GapiLens.t
Sourceval annotations : (t, Annotations.t) GapiLens.t
Sourceval enumDescriptions : (t, string list) GapiLens.t
Sourceval location : (t, string) GapiLens.t
Sourceval default : (t, string) GapiLens.t
Sourceval description : (t, string) GapiLens.t
Sourceval deprecated : (t, bool) GapiLens.t
Sourceval properties : (t, (string * t) list) GapiLens.t
Sourceval enum : (t, string list) GapiLens.t
Sourceval additionalProperties : (t, t option) GapiLens.t
Sourceval id : (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
OCaml

Innovation. Community. Security.