From 3d10a7ae7162b915e54e4d1ea41e69c2799c5ebf Mon Sep 17 00:00:00 2001 From: Stuart Holland Date: Tue, 24 Sep 2024 15:10:59 +0100 Subject: [PATCH] Added more clarity to REST integration docs. (#34885) --- source/_integrations/rest.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index 1ceb59b5bcc..416253f78a6 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -128,21 +128,21 @@ payload: required: false type: string payload_template: - description: The payload to send with a POST request with template support. Depends on the service, but usually formed as JSON. + description: The payload to send with a POST request, with template support. Depends on the service, but usually formed as JSON. required: false type: template verify_ssl: - description: Verify the SSL certificate of the endpoint. + description: Whether to verify the SSL certificate of the endpoint. required: false type: boolean default: True ssl_cipher_list: - description: Define the list of SSL ciphers to be accepted from this endpoint. `python_default` (_default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_). + description: The list of SSL ciphers to be accepted from this endpoint. `python_default` (_default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_). required: false type: string default: default timeout: - description: Defines max time to wait data from the endpoint. + description: The maximum time in seconds to wait for data from the endpoint. If the timeout is reached, the sensor will become `unavailable`. required: false type: integer default: 10 @@ -167,7 +167,7 @@ params: required: false type: [list, template] scan_interval: - description: Define the refrequency to call the REST endpoint in seconds. + description: The frequency in seconds to call the REST endpoint. required: false type: integer default: 30