Skip to content

Commit

Permalink
Update API doc for cluster_host
Browse files Browse the repository at this point in the history
Correct mistakes on `joined` field and add more details on `destroy` message.

Signed-off-by: Vincent Liu <[email protected]>
  • Loading branch information
Vincent-lau committed Feb 7, 2024
1 parent 4e0a1e1 commit 2c95050
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions ocaml/idl/datamodel_cluster_host.ml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ let create =
()

let destroy =
call ~name:"destroy" ~doc:"Remove a host from an existing cluster."
call ~name:"destroy"
~doc:
"Remove the host from an existing cluster. This operation is allowed \
even if a cluster host is not enabled."
~params:
[
( Ref _cluster_host
Expand Down Expand Up @@ -117,10 +120,8 @@ let t =
~default_value:(Some (VBool true))
"Whether the cluster host has joined the cluster. Contrary to \
enabled, a host that is not joined is not considered a member of \
the cluster, and hence no operations (e.g. enable/disable) can be \
performed on this host. This field can be altered by calling leave \
or destroy on a cluster host. It can also be set automatically if \
cluster stack believes that this node is not part of the cluster. "
the cluster, and hence enable and disable operations cannot be \
performed on this host."
; field ~qualifier:DynamicRO ~lifecycle:[] ~ty:Bool "live"
~default_value:(Some (VBool false))
"Whether the underlying cluster stack thinks we are live. This \
Expand Down
2 changes: 1 addition & 1 deletion ocaml/idl/schematest.ml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ let hash x = Digest.string x |> Digest.to_hex
(* BEWARE: if this changes, check that schema has been bumped accordingly in
ocaml/idl/datamodel_common.ml, usually schema_minor_vsn *)

let last_known_schema_hash = "1e43ef93af9de55620fda75281e8a992"
let last_known_schema_hash = "2de13a69470d10b12910322f8a6bce85"

let current_schema_hash : string =
let open Datamodel_types in
Expand Down

0 comments on commit 2c95050

Please sign in to comment.