package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

package ez_api

ez_api
- EzAPI
  - Arg
    
    Ty
    
    Ty
  - Doc
  - Err
    
    IntMap
  - Error_codes
  - Legacy
  - Meth
  - Mime
  - Param
  - Path
  - Req
    
    StringMap
  - Security
    
    StringSet
  - Service
    
    IO
  - TYPES
  - Url
    
    TYPES
ez_api.debug_unix
- EzDebug
ez_api.encoding
- EzEncoding
  - Ezjsonm
ez_api.ezjsonm_unix
- Ezjsonm_interface
ez_api.facebook_auth
- Facebook
  - Encoding
  - Services
  - Types
ez_api.google_auth
- Google
  - Encoding
  - Services
  - Types
ez_api.iserver_default
- EzServer
ez_api.lwt_unix
- EzLwtSys
ez_api.md5
- EzHash
ez_api.openAPI
- EzOpenAPI
  - Encoding
  - Makers
  - Types
ez_api.req_default
- EzReq
  - Interface
  - Legacy
ez_api.req_lwt_default
- EzReq_lwt
  - Interface
  - Legacy
ez_api.request
- EzRequest
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_lwt
- EzRequest_lwt
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.sendgrid_encoding
- EzSendgrid_encoding
- EzSendgrid_types
ez_api.sendgrid_services
- EzSendgrid_services
ez_api.server
- EzAPIServer
ez_api.server_session
- EzCookieServer
- EzSessionServer
  - Arg
    
    SessionArg
    
    SessionStore
  - Make
    
    S
    
    SessionArg
    
    SessionStore
  - SessionStore
  - SessionStoreInMemory
  - UserStoreInMemory
    
    S
    
    SessionArg
    
    SessionStore
ez_api.server_utils
- EzAPIServerUtils
  - Answer
  - Directory
    
    MethMap
    
    Step
    
    StringMap
  - File
    
    FileString
  - GMTime
  - Ip
  - Legacy
  - StringMap
  - Timings
ez_api.session
- EzSession
  - Hash
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
ez_api.ws_server_cohttp
- WsCohttp
ez_api.ws_server_httpaf
- WsHttpaf
ez_api.ws_types
- EzWsCommon
  - S
  - Types

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = {

doc_id : int;
doc_name : string option;
doc_descr : string option;
doc_path : string;
doc_args : Arg.descr list;
doc_params : Param.t list;
mutable doc_registered : bool;
doc_section : section;
doc_input : Json_schema.schema Lazy.t option;
doc_output : Json_schema.schema Lazy.t option;
doc_mime : Mime.t list;
doc_errors : (int * Json_schema.schema Lazy.t) list;
doc_meth : Meth.t;
doc_security : Security.scheme list;
doc_input_example : Json_repr.any option;
doc_output_example : Json_repr.any option;

}

and section = {

section_name : string;
mutable section_docs : t list;

}

val default_section : section

val sections : section list ref

val definitions_path : string

val update_service_list : t list -> t -> t list

val make : 
  'i. ?name:string ->
  ?descr:string ->
  ?register:bool ->
  ?section:section ->
  ?input_example:'i ->
  ?output_example:'o ->
  ('a, 'i, 'o, 'b, [< Security.scheme ]) Service.t ->
  t

val section : string -> section

val all_services_registered : unit -> bool

val section_name : section -> string

val nservices : unit -> int

val services : unit -> string array