diff options
Diffstat (limited to 'src/mod_http_api.erl')
| -rw-r--r-- | src/mod_http_api.erl | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/src/mod_http_api.erl b/src/mod_http_api.erl index 912299e45..3a1b22034 100644 --- a/src/mod_http_api.erl +++ b/src/mod_http_api.erl @@ -524,5 +524,13 @@ mod_options(_) -> mod_doc() -> #{desc => - ?T("This module provides a ReST API to call " - "ejabberd commands using JSON data.")}. + [?T("This module provides a ReST API to call ejabberd commands " + "using JSON data."), "", + ?T("To use this module, in addition to adding it to the 'modules' " + "section, you must also add it to 'request_handlers' of some " + "listener."), "", + ?T("To use a specific API version N, when defining the URL path " + "in the request_handlers, add a 'vN'. " + "For example: '/api/v2: mod_http_api'"), "", + ?T("To run a command, send a POST request to the corresponding " + "URL: 'http://localhost:5280/api/<command_name>'")]}. |