emqx_bridge_http_schema.hocon 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. emqx_bridge_http_schema {
  2. config_body.desc:
  3. """The body of the HTTP request.<br/>
  4. If not provided, the body will be a JSON object of all the available fields.<br/>
  5. There, 'all the available fields' means the context of a MQTT message when
  6. this webhook is triggered by receiving a MQTT message (the `local_topic` is set),
  7. or the context of the event when this webhook is triggered by a rule (i.e. this
  8. webhook is used as an action of a rule).<br/>
  9. Template with variables is allowed."""
  10. config_body.label:
  11. """HTTP Body"""
  12. config_enable_bridge.desc:
  13. """Enable or disable this action."""
  14. config_enable_bridge.label:
  15. """Enable Or Disable Bridge"""
  16. config_headers.desc:
  17. """The headers of the HTTP request.<br/>
  18. Template with variables is allowed."""
  19. config_headers.label:
  20. """HTTP Header"""
  21. config_local_topic.desc:
  22. """The MQTT topic filter to be forwarded to the HTTP server. All MQTT 'PUBLISH' messages with the topic
  23. matching the local_topic will be forwarded.<br/>
  24. NOTE: If this action is used as the action of a rule (EMQX rule engine), and also local_topic is
  25. configured, then both the data got from the rule and the MQTT messages that match local_topic
  26. will be forwarded."""
  27. config_local_topic.label:
  28. """Local Topic"""
  29. config_max_retries.desc:
  30. """HTTP request max retry times if failed."""
  31. config_max_retries.label:
  32. """HTTP Request Max Retries"""
  33. config_method.desc:
  34. """The method of the HTTP request. All the available methods are: post, put, get, delete.<br/>
  35. Template with variables is allowed."""
  36. config_method.label:
  37. """HTTP Method"""
  38. config_request_timeout.desc:
  39. """HTTP request timeout."""
  40. config_request_timeout.label:
  41. """HTTP Request Timeout"""
  42. config_url.desc:
  43. """The URL of the HTTP action.<br/>
  44. Template with variables is allowed in the path, but variables cannot be used in the scheme, host,
  45. or port part.<br/>
  46. For example, <code> http://localhost:9901/${topic} </code> is allowed, but
  47. <code> http://${host}:9901/message </code> or <code> http://localhost:${port}/message </code>
  48. is not allowed."""
  49. config_url.label:
  50. """URL"""
  51. config_path.desc:
  52. """The URL path for this Action.<br/>
  53. This path will be appended to the Connector's <code>url</code> configuration to form the full
  54. URL address.
  55. Template with variables is allowed in this option. For example, <code>/room/{$room_no}</code>"""
  56. config_path.label:
  57. """URL Path"""
  58. config_parameters_opts.desc:
  59. """The parameters for HTTP action."""
  60. config_parameters_opts.label:
  61. """Parameters"""
  62. desc_config.desc:
  63. """Configuration for an HTTP action."""
  64. desc_config.label:
  65. """HTTP Action Configuration"""
  66. desc_name.desc:
  67. """Action name, used as a human-readable identifier."""
  68. desc_name.label:
  69. """Action Name"""
  70. desc_type.desc:
  71. """The action type."""
  72. desc_type.label:
  73. """Action Type"""
  74. }