fix(cbr): docs fixed (#620)

fix(cbr): docs fixed

Reviewed-by: Anton Sidelnikov
Reviewed-by: Dmitrii Sabelnikov

Author: RusselSand

examples/cbr/delete_policy.py

@@ -20,5 +20,5 @@
 
 
 policy = '52606d56-d129-44d1-85da-1cc7b837942e'
-policy = conn.cbr.find_policy(name_or_id=policy)
+policy = conn.cbr.find_policy(policy_id=policy)
 conn.cbr.delete_policy(policy=policy)

examples/cbr/find_policy.py

@@ -20,5 +20,5 @@
 
 
 policy = 'name_or_id'
-policy = conn.cbr.find_policy(name_or_id=policy)
+policy = conn.cbr.find_policy(policy_id=policy)
 print(policy)

examples/cbr/update_policy.py

@@ -40,6 +40,6 @@
 }
 
 policy = 'name_or_id'
-policy = conn.cbr.find_policy(name_or_id=policy)
+policy = conn.cbr.find_policy(policy_id=policy)
 policy = conn.cbr.update_policy(policy=policy, **attrs)
 print(policy)

otcextensions/osclient/cbr/v3/policy.py

@@ -138,7 +138,7 @@ def take_action(self, parsed_args):
         client = self.app.client_manager.cbr
 
         obj = client.find_policy(
-            name_or_id=parsed_args.policy,
+            policy_id=parsed_args.policy,
             ignore_missing=False
         )
 
@@ -486,7 +486,7 @@ def take_action(self, parsed_args):
 
         client = self.app.client_manager.cbr
         policy = client.find_policy(
-            name_or_id=parsed_args.policy,
+            policy_id=parsed_args.policy,
             ignore_missing=False
         )
 
@@ -525,7 +525,7 @@ def take_action(self, parsed_args):
         client = self.app.client_manager.cbr
 
         policy = client.find_policy(
-            name_or_id=parsed_args.policy,
+            policy_id=parsed_args.policy,
             ignore_missing=False
         )
 

otcextensions/sdk/cbr/v3/_proxy.py

@@ -185,10 +185,10 @@ def get_policy(self, policy):
             _policy.Policy, policy
         )
 
-    def find_policy(self, name_or_id, ignore_missing=True):
-        """Find a single CBR policy by name or ID
+    def find_policy(self, policy_id, ignore_missing=True):
+        """Find a single CBR policy by ID
 
-        :param name_or_id: The name or ID of a policy
+        :param policy_id: The ID of a policy
         :param bool ignore_missing: When set to ``False``
             :class:`~openstack.exceptions.ResourceNotFound` will be raised
             when the policy does not exist.
@@ -197,7 +197,7 @@ def find_policy(self, name_or_id, ignore_missing=True):
 
         :returns: a :class:`~otcextensions.sdk.cbr.v3.policy.Policy` instance
         """
-        return self._find(_policy.Policy, name_or_id,
+        return self._find(_policy.Policy, policy_id,
                           ignore_missing=ignore_missing)
 
     def create_policy(self, **attrs):

otcextensions/tests/unit/osclient/cbr/v3/test_policy.py

@@ -219,7 +219,7 @@ def test_default(self):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.client.find_policy.assert_called_once_with(
-            name_or_id='policy',
+            policy_id='policy',
             ignore_missing=False,
         )
 
@@ -277,7 +277,7 @@ def test_delete(self):
 
         find_calls = [
             mock.call(
-                name_or_id='p1',
+                policy_id='p1',
                 ignore_missing=False),
         ]
 
@@ -482,7 +482,7 @@ def test_default(self):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.client.find_policy.assert_called_with(
-            name_or_id='policy_id',
+            policy_id='policy_id',
             ignore_missing=False)
 
         self.client.update_policy.assert_called_once_with(

releasenotes/notes/cbr-policy-update-abedc3fbbfd3aa32.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixed variable names and description in CBR policy configuration to ensure clarity and consistency.