CP-24903: Rename add/remove_purpose parameters

"self" and "value", instead of "network" and "purpose"
(for consistency with what the autogenerated functions would be if
the field were RW)

Signed-off-by: Thomas Sanders <[email protected]>

Author: thomassa

ocaml/idl/datamodel.ml

@@ -5275,8 +5275,8 @@ let network_add_purpose = call
   ~name:"add_purpose"
   ~doc:"Give a network a new purpose (if not present already)"
   ~params:[
-    Ref _network, "network", "The network";
-    network_purpose, "purpose", "The purpose to add";
+    Ref _network, "self", "The network";
+    network_purpose, "value", "The purpose to add";
   ]
   ~errs:[Api_errors.network_incompatible_purposes]
   ~in_product_since:rel_inverness
@@ -5287,8 +5287,8 @@ let network_remove_purpose = call
   ~name:"remove_purpose"
   ~doc:"Remove a purpose from a network (if present)"
   ~params:[
-    Ref _network, "network", "The network";
-    network_purpose, "purpose", "The purpose to remove";
+    Ref _network, "self", "The network";
+    network_purpose, "value", "The purpose to remove";
   ]
   ~in_product_since:rel_inverness
   ~allowed_roles:_R_POOL_ADMIN

ocaml/xapi/message_forwarding.ml

@@ -2751,13 +2751,13 @@ module Forward = functor(Local: Custom_actions.CUSTOM_ACTIONS) -> struct
       do_op_on ~local_fn ~__context ~host
         (fun session_id rpc -> Client.Network.detach_for_vm rpc session_id host vm)
 
-    let add_purpose ~__context ~network ~purpose =
-      info "Network.add_purpose: network = '%s'; purpose = '%s'" (network_uuid ~__context network) (Record_util.network_purpose_to_string purpose);
-      Local.Network.add_purpose ~__context ~network ~purpose
+    let add_purpose ~__context ~self ~value =
+      info "Network.add_purpose: self = '%s'; value = '%s'" (network_uuid ~__context self) (Record_util.network_purpose_to_string value);
+      Local.Network.add_purpose ~__context ~self ~value
 
-    let remove_purpose ~__context ~network ~purpose =
-      info "Network.remove_purpose: network = '%s'; purpose = '%s'" (network_uuid ~__context network) (Record_util.network_purpose_to_string purpose);
-      Local.Network.remove_purpose ~__context ~network ~purpose
+    let remove_purpose ~__context ~self ~value =
+      info "Network.remove_purpose: self = '%s'; value = '%s'" (network_uuid ~__context self) (Record_util.network_purpose_to_string value);
+      Local.Network.remove_purpose ~__context ~self ~value
 
   end
 

ocaml/xapi/xapi_network.ml

@@ -353,18 +353,16 @@ let assert_can_add_purpose ~__context ~network ~current newval =
   | `nbd -> assert_no_net_has_bad_porpoise [`insecure_nbd]
   | `insecure_nbd -> assert_no_net_has_bad_porpoise [`nbd]
 
-let add_purpose ~__context ~network ~purpose =
-  let self = network in
+let add_purpose ~__context ~self ~value =
   let current = Db.Network.get_purposes ~__context ~self in
-  if not (List.mem purpose current) then (
-    assert_can_add_purpose ~__context ~network ~current purpose;
-    Db.Network.set_purposes ~__context ~self ~value:(purpose::current)
+  if not (List.mem value current) then (
+    assert_can_add_purpose ~__context ~network:self ~current value;
+    Db.Network.set_purposes ~__context ~self ~value:(value::current)
   )
 
-let remove_purpose ~__context ~network ~purpose =
-  let self = network in
+let remove_purpose ~__context ~self ~value =
   let current = Db.Network.get_purposes ~__context ~self in
-  if (List.mem purpose current) then (
-    let porpoises = List.filter (fun porpoise -> porpoise<>purpose) current in
+  if (List.mem value current) then (
+    let porpoises = List.filter ((<>) value) current in
     Db.Network.set_purposes ~__context ~self ~value:(porpoises)
   )

ocaml/xapi/xapi_network.mli

@@ -133,14 +133,14 @@ val with_networks_attached_for_vm :
 
 val add_purpose :
   __context:Context.t ->
-  network:[ `network ] Ref.t ->
-  purpose:API.network_purpose ->
+  self:[ `network ] Ref.t ->
+  value:API.network_purpose ->
   unit
 
 val remove_purpose :
   __context:Context.t ->
-  network:[ `network ] Ref.t ->
-  purpose:API.network_purpose ->
+  self:[ `network ] Ref.t ->
+  value:API.network_purpose ->
   unit
 
 (** {2 Assertion Helper Functions} *)