diff options
| author | Badlop <badlop@process-one.net> | 2021-08-18 13:39:17 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2021-08-23 14:04:35 +0200 |
| commit | b7f7713faefeab6f45994c0c940497b1c3ee7619 (patch) | |
| tree | e7c8e4f4d1877731203b694a0da1c59a0565b6e4 | |
| parent | Update API Reference page menu name and order (diff) | |
Add example config to mod_http_api documentation
| -rw-r--r-- | src/mod_http_api.erl | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/mod_http_api.erl b/src/mod_http_api.erl index 0a3942024..0f494bb3a 100644 --- a/src/mod_http_api.erl +++ b/src/mod_http_api.erl @@ -533,4 +533,14 @@ mod_doc() -> "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>'")]}. + "URL: 'http://localhost:5280/api/<command_name>'")], + example => + ["listen:", + " -", + " port: 5280", + " module: ejabberd_http", + " request_handlers:", + " /api: mod_http_api", + "", + "modules:", + " mod_http_api: {}"]}. |