github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add more details on SkipNodeUpdate option (#5345) 

* Add more details on SkipNodeUpdate option

* Updating the language for the entire parameter.
pull/5391/head
danielehc 2019-02-26 18:00:23 +01:00 committed by kaitlincarter-hc
parent 786b3b1095
commit f3610df40b
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/source/api/catalog.html.md
View File

@ -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.