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.request_verbose
- Verbose
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
    
    Service
  - 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
  - M
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
    
    Service
    
    _
    
    Legacy
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

Definition for services and their security's configuration.

type user_id = S.user_id

type user_info = S.user_info

type nonrec auth = auth

val section_session : EzAPI.Doc.section

Documentation section for openapi.

val param_token : EzAPI.Param.t

Parameter with name token that stores an authentication token string

type token_security = [

]

Type that represents security by authentication token and the way that request uses to store it.

val param_security : [> `Query of EzAPI.Param.t EzAPI.Security.apikey ]

Security that requires param_token parameter in query.

val header_cookie_security : 
  [> `Cookie of string EzAPI.Security.apikey * int64 option
  | `Header of string EzAPI.Security.apikey ]

Security that checks S.token_kind: If it is a CSRF token, then requires a CSRF header. Otherwise requires token to be found in the cookies.

val security : token_security list

Security that combines param_security and header_cookie_security in the corresponding order. Represents the security configuration for connect and logout requests.

val rpc_root : (EzAPI.Req.t, EzAPI.Req.t) EzAPI.Path.t

Defines path to authentication services

val access_control : (string * string) list

val connect : 
  (auth TYPES.connect_response, TYPES.connect_error, token_security)
    EzAPI.service0

Connection service that requires authentication token. For more details, see corresponding EzSessionServer.Make.connect handler and default client request implementation

EzSessionClient.Make.connect.

val login : 
  (TYPES.login_message,
    (S.user_id, S.user_info) TYPES.login_response,
    TYPES.login_error,
    EzAPI.Security.none)
    EzAPI.post_service0

Logining service. For more details, see corresponding EzSessionServer.Make.login handler and default client request implementation EzSessionClient.Make.login.

val logout : 
  (TYPES.auth_needed, TYPES.logout_error, token_security) EzAPI.service0

Disconnection service that requires authentication token. For more details, see corresponding EzSessionServer.Make.logout handler and default client request implementation EzSessionClient.Make.logout.