package ez_api
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ed68e0a33325ecf6a3319cafa636d62e
sha512=425c6289d568cf697e8d9977ac43e2ebcdeec8f04f5a17225824d5a37ac700961e5d1283b92aeaebaf58ccfb5b4261bcba1180ab11c267ade0de86b68fd6ca2d
doc/ez_api.session/EzSession/Make/Service/index.html
Module Make.ServiceSource
Definition for services and their security's configuration.
Documentation section for openapi.
Parameter with name token that stores an authentication token string
Type that represents security by authentication token and the way that request uses to store it.
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.
Security that combines param_security and header_cookie_security in the corresponding order. Represents the security configuration for connect and logout requests.
Defines path to authentication services
val connect :
(auth TYPES.connect_response, TYPES.connect_error, token_security)
EzAPI.service0Connection 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_service0Logining service. For more details, see corresponding EzSessionServer.Make.login handler and default client request implementation EzSessionClient.Make.login.
Disconnection service that requires authentication token. For more details, see corresponding EzSessionServer.Make.logout handler and default client request implementation EzSessionClient.Make.logout.