From f3610df40b1effcabb242413155bb82e78ef7bc6 Mon Sep 17 00:00:00 2001 From: danielehc <40759828+danielehc@users.noreply.github.com> Date: Tue, 26 Feb 2019 18:00:23 +0100 Subject: [PATCH] Add more details on SkipNodeUpdate option (#5345) * Add more details on SkipNodeUpdate option * Updating the language for the entire parameter. --- website/source/api/catalog.html.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/website/source/api/catalog.html.md b/website/source/api/catalog.html.md index 9fcf205d42..c1907d6d59 100644 --- a/website/source/api/catalog.html.md +++ b/website/source/api/catalog.html.md @@ -76,8 +76,12 @@ The table below shows this endpoint's support for sending an array of `Check` objects. - `SkipNodeUpdate` `(bool: false)` - Specifies whether to skip updating the - node part of the registration. Useful in the case where only a health check - or service entry on a node needs to be updated. + node's information in the registration. This is useful in the case where + only a health check or service entry on a node needs to be updated or when + a register request is intended to update a service entry or health check. + In both use cases, node information will not be overwritten, if the node is + already registered. Note, if the paramater is enabled for a node that doesn't + exist, it will still be created. It is important to note that `Check` does not have to be provided with `Service` and vice versa. A catalog entry can have either, neither, or both.