From 2c9505032d5c2eda3709a95676f70f6137d15127 Mon Sep 17 00:00:00 2001 From: Vincent Liu Date: Wed, 31 Jan 2024 17:52:08 +0000 Subject: [PATCH] Update API doc for cluster_host Correct mistakes on `joined` field and add more details on `destroy` message. Signed-off-by: Vincent Liu --- ocaml/idl/datamodel_cluster_host.ml | 11 ++++++----- ocaml/idl/schematest.ml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/ocaml/idl/datamodel_cluster_host.ml b/ocaml/idl/datamodel_cluster_host.ml index af10edd5936..5a45228048f 100644 --- a/ocaml/idl/datamodel_cluster_host.ml +++ b/ocaml/idl/datamodel_cluster_host.ml @@ -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 @@ -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 \ diff --git a/ocaml/idl/schematest.ml b/ocaml/idl/schematest.ml index cb84842f770..9e716508844 100644 --- a/ocaml/idl/schematest.ml +++ b/ocaml/idl/schematest.ml @@ -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