Fix allow patch error (#661)

shhovhan · web-flow · commit 7b5d280fb7b7 · 2026-04-30T07:28:56.000Z
Fix allow patch error

In this PR I fixed the following type of errror:

allow_patch = True requires commit_method = 'PATCH', but the default is PUT. Since allow_commit = True already handles PUT updates, I removed the conflicting allow_patch = True.

Reviewed-by: Anton Sidelnikov
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -79,6 +79,7 @@
 pygments_style = "native"
 
 autodoc_member_order = "bysource"
+autodoc_class_signature = "separated"
 
 # Locations to exclude when looking for source files.
 exclude_patterns = []
diff --git a/doc/source/sdk/guides/privatenat.rst b/doc/source/sdk/guides/privatenat.rst
@@ -199,3 +199,12 @@ This interface is used to assign a transit IP address.
 
 .. literalinclude:: ../examples/natv3/create_private_transit_ip.py
    :lines: 16-28
+
+Delete Private Transit IP Address
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This interface is used to delete a transit IP address.
+:class:`~otcextensions.sdk.natv3.v3.transit_ip.PrivateTransitIp`.
+
+.. literalinclude:: ../examples/natv3/delete_private_transit_ip.py
+   :lines: 16-22
diff --git a/doc/source/sdk/guides/vpcep.rst b/doc/source/sdk/guides/vpcep.rst
@@ -22,7 +22,7 @@ List Services
 
 This interface is used to query an VPCEP services list and to filter
 the output with query parameters.
-:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
+:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
 
 .. literalinclude:: ../examples/vpcep/list_endpoints.py
    :lines: 14-20
@@ -32,7 +32,7 @@ Create Service
 
 This interface is used to create a VPCEP service with
 parameters.
-:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
+:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
 
 .. literalinclude:: ../examples/vpcep/create_service.py
    :lines: 14-30
@@ -42,7 +42,7 @@ Get Service
 
 This interface is used to get a VPCEP service by ID
 or an instance of class.
-:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
+:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
 
 .. literalinclude:: ../examples/vpcep/get_service.py
    :lines: 14-21
@@ -52,7 +52,7 @@ Find Service
 
 This interface is used to find a VPCEP service by ID
 or name.
-:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
+:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
 
 .. literalinclude:: ../examples/vpcep/find_service.py
    :lines: 14-21
@@ -62,7 +62,7 @@ Delete Service
 
 This interface is used to delete a VPCEP service by ID
 or an instance of class
-:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
+:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
 
 .. literalinclude:: ../examples/vpcep/delete_service.py
    :lines: 14-20
@@ -72,7 +72,7 @@ List Service Whitelist
 
 This interface is used to query an VPCEP service whitelist and to filter
 the output with query parameters.
-:class:`~otcextensions.sdk.vpcep.v2.whitelist.Whitelist`.
+:class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`.
 
 .. literalinclude:: ../examples/vpcep/list_service_whitelist.py
    :lines: 14-22
@@ -81,7 +81,7 @@ Manage Service Whitelist
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 This interface is used to manage a VPCEP service whitelist.
-:class:`~otcextensions.sdk.vpcep.v2.whitelist.Whitelist`.
+:class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`.
 
 .. literalinclude:: ../examples/vpcep/manage_service_whitelist.py
    :lines: 14-26
@@ -91,7 +91,7 @@ List Service Connections
 
 This interface is used to query an VPCEP service connections and to filter
 the output with query parameters.
-:class:`~otcextensions.sdk.vpcep.v2.connection.Connection`.
+:class:`~otcextensions.sdk.vpcep.v1.connection.Connection`.
 
 .. literalinclude:: ../examples/vpcep/list_service_connections.py
    :lines: 14-22
@@ -100,7 +100,7 @@ Manage Service Connections
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This interface is used to manage a VPCEP service connections.
-:class:`~otcextensions.sdk.vpcep.v2.connection.Connection`.
+:class:`~otcextensions.sdk.vpcep.v1.connection.Connection`.
 
 .. literalinclude:: ../examples/vpcep/manage_service_connections.py
    :lines: 14-25
@@ -116,7 +116,7 @@ List Endpoints
 
 This interface is used to query an VPC endpoint list and to filter
 the output with query parameters.
-:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
+:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
 
 .. literalinclude:: ../examples/vpcep/list_endpoints.py
    :lines: 14-20
@@ -126,7 +126,7 @@ Create Endpoint
 
 This interface is used to create a VPC endpoint with
 parameters.
-:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
+:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
 
 .. literalinclude:: ../examples/vpcep/create_endpoint.py
    :lines: 14-28
@@ -136,7 +136,7 @@ Get Endpoint
 
 This interface is used to get a VPC endpoint by ID
 or an instance of class
-:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
+:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
 
 .. literalinclude:: ../examples/vpcep/get_endpoint.py
    :lines: 14-21
@@ -146,7 +146,7 @@ Delete Endpoint
 
 This interface is used to delete a VPC endpoint by ID
 or an instance of class
-:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
+:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
 
 .. literalinclude:: ../examples/vpcep/delete_endpoint.py
    :lines: 14-20
@@ -159,8 +159,7 @@ List Resource Quota
 
 This interface is used to query quota of vpc endpoint and endpoint_service
 on a specific tenant.
-:class:`~otcextensions.sdk.vpcep.v2.quota.Quota`.
+:class:`~otcextensions.sdk.vpcep.v1.quota.Quota`.
 
 .. literalinclude:: ../examples/vpcep/list_resource_quota.py
    :lines: 14-20
-
diff --git a/doc/source/sdk/proxies/privatenat.rst b/doc/source/sdk/proxies/privatenat.rst
@@ -16,4 +16,7 @@ Private NAT Gateway Operations
 
 .. autoclass:: otcextensions.sdk.natv3.v3._proxy.Proxy
   :noindex:
-  :members: private_nat_gateways, get_private_nat_gateway, private_dnat_rules, create_private_dnat_rule, update_private_dnat_rule, delete_private_dnat_rule, private_snat_rules, create_private_snat_rule, update_private_snat_rule, delete_private_snat_rule, private_transit_ips, get_private_transit_ip, create_private_transit_ip
+  :members: private_nat_gateways, get_private_nat_gateway, private_dnat_rules, create_private_dnat_rule,
+    update_private_dnat_rule, delete_private_dnat_rule, private_snat_rules, create_private_snat_rule,
+    update_private_snat_rule, delete_private_snat_rule, private_transit_ips, get_private_transit_ip,
+    create_private_transit_ip, delete_private_transit_ip
diff --git a/doc/source/sdk/resources/vpcep/v1/connection.rst b/doc/source/sdk/resources/vpcep/v1/connection.rst
@@ -1,4 +1,4 @@
-otcextensions.sdk.vpecp.v1.connection
+otcextensions.sdk.vpcep.v1.connection
 =====================================
 
 .. automodule:: otcextensions.sdk.vpcep.v1.connection
diff --git a/examples/natv3/delete_private_transit_ip.py b/examples/natv3/delete_private_transit_ip.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""
+Delete a private transit IP address.
+"""
+
+import openstack
+
+openstack.enable_logging(True)
+conn = openstack.connect(cloud="otc")
+
+conn.natv3.delete_private_transit_ip("a2845109-3b2f-4627-b08f-09a726c0a6e7")
diff --git a/otcextensions/osclient/privatenat/v3/transit_ip.py b/otcextensions/osclient/privatenat/v3/transit_ip.py
@@ -14,6 +14,7 @@
 
 import logging
 
+from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.command import command
 
@@ -262,3 +263,27 @@ def take_action(self, parsed_args):
         data = utils.get_item_properties(obj, columns)
 
         return display_columns, data
+
+
+class DeletePrivateTransitIp(command.Command):
+    _description = _("Delete a private transit IP address.")
+
+    def get_parser(self, prog_name):
+        parser = super(DeletePrivateTransitIp, self).get_parser(prog_name)
+        parser.add_argument(
+            "transit_ip",
+            metavar="<transit_ip>",
+            help=_("Specifies the transit IP address ID."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.privatenat
+
+        try:
+            client.delete_private_transit_ip(parsed_args.transit_ip)
+        except Exception as e:
+            msg = _(
+                "Failed to delete private transit IP address with ID '%(id)s': %(e)s"
+            ) % {"id": parsed_args.transit_ip, "e": e}
+            raise exceptions.CommandError(msg)
diff --git a/otcextensions/sdk/apig/v2/custom_authorizer.py b/otcextensions/sdk/apig/v2/custom_authorizer.py
@@ -24,7 +24,6 @@ class CustomAuthorizer(resource.Resource):
     allow_list = True
     allow_fetch = True
     allow_create = True
-    allow_patch = True
     allow_delete = True
     allow_commit = True
 
diff --git a/otcextensions/sdk/cce/v3/_base.py b/otcextensions/sdk/cce/v3/_base.py
@@ -123,7 +123,7 @@ def _translate_response(
 
                 self._body.attributes.update(body_attrs)
                 self._body.clean()
-                if self.commit_jsonpatch or self.allow_patch:
+                if self.allow_patch:
                     # We need the original body to compare against
                     self._original_body = body_attrs.copy()
             except ValueError:
diff --git a/otcextensions/sdk/css/v1/cluster.py b/otcextensions/sdk/css/v1/cluster.py
@@ -439,7 +439,7 @@ def _translate_response(
 
                 self._body.attributes.update(body_attrs)
                 self._body.clean()
-                if self.commit_jsonpatch or self.allow_patch:
+                if self.allow_patch:
                     # We need the original body to compare against
                     self._original_body = body_attrs.copy()
             except ValueError:
diff --git a/otcextensions/sdk/dis/v2/dump_task.py b/otcextensions/sdk/dis/v2/dump_task.py
@@ -81,7 +81,6 @@ class DumpTask(resource.Resource):
     allow_commit = True
     allow_delete = True
     allow_fetch = True
-    allow_patch = True
 
     #: Name of the stream to which the dump task belongs.
     uri_stream_name = resource.URI("uri_stream_name")
diff --git a/otcextensions/sdk/dis/v2/stream.py b/otcextensions/sdk/dis/v2/stream.py
@@ -24,7 +24,6 @@ class Stream(resource.Resource):
     allow_commit = True
     allow_delete = True
     allow_fetch = True
-    allow_patch = True
 
     _query_mapping = resource.QueryParameters("limit", "start_stream_name")
 
diff --git a/otcextensions/sdk/dws/v1/cluster.py b/otcextensions/sdk/dws/v1/cluster.py
@@ -26,7 +26,6 @@ class Cluster(resource.Resource):
     allow_commit = True
     allow_delete = True
     allow_fetch = True
-    allow_patch = True
 
     # Properties
     #: The key indicates an ongoing task.
diff --git a/otcextensions/sdk/lts/v2/group.py b/otcextensions/sdk/lts/v2/group.py
@@ -79,11 +79,6 @@ def commit(
         if not self.requires_commit:
             return self
 
-        # Avoid providing patch unconditionally to avoid breaking subclasses
-        # without it.
-        if self.commit_jsonpatch:
-            kwargs["patch"] = True
-
         request = self._prepare_request(
             prepend_key=prepend_key,
             base_path=base_path,
diff --git a/otcextensions/sdk/modelartsv1/v1/devenv.py b/otcextensions/sdk/modelartsv1/v1/devenv.py
@@ -254,7 +254,6 @@ class Devenv(resource.Resource):
     allow_commit = True
     allow_delete = True
     allow_fetch = True
-    allow_patch = True
 
     # Properties
 
@@ -354,7 +353,7 @@ def _translate_response(
             body = self._consume_body_attrs(body)
             self._body.attributes.update(body)
             self._body.clean()
-            if self.commit_jsonpatch:
+            if self.allow_patch:
                 # We need the original body to compare against
                 self._original_body = body.copy()
 
diff --git a/otcextensions/sdk/modelartsv1/v1/job_resource_specifications.py b/otcextensions/sdk/modelartsv1/v1/job_resource_specifications.py
@@ -19,7 +19,6 @@ class JobResourceSpecifications(resource.Resource):
 
     allow_list = True
     allow_fetch = True
-    allow_patch = True
 
     #: Job type
     job_type = resource.Body("job_type", type=str)
diff --git a/otcextensions/sdk/modelartsv1/v1/model.py b/otcextensions/sdk/modelartsv1/v1/model.py
@@ -319,7 +319,7 @@ def _translate_response(
 
                 self._body.attributes.update(body_attrs)
                 self._body.clean()
-                if self.commit_jsonpatch or self.allow_patch:
+                if self.allow_patch:
                     # We need the original body to compare against
                     self._original_body = body_attrs.copy()
             except ValueError:
diff --git a/otcextensions/sdk/modelartsv1/v1/service.py b/otcextensions/sdk/modelartsv1/v1/service.py
@@ -284,7 +284,7 @@ def _translate_response(
 
                 self._body.attributes.update(body_attrs)
                 self._body.clean()
-                if self.commit_jsonpatch or self.allow_patch:
+                if self.allow_patch:
                     # We need the original body to compare against
                     self._original_body = body_attrs.copy()
             except ValueError:
diff --git a/otcextensions/sdk/modelartsv2/v2/dataset_import_task.py b/otcextensions/sdk/modelartsv2/v2/dataset_import_task.py
@@ -40,7 +40,6 @@ class DatasetImportTask(resource.Resource):
     allow_create = True
     allow_list = True
     allow_fetch = True
-    allow_patch = True
 
     # Properties
     #: Number of labeled samples.
diff --git a/otcextensions/sdk/natv3/v3/_proxy.py b/otcextensions/sdk/natv3/v3/_proxy.py
@@ -277,3 +277,21 @@ def create_private_transit_ip(self, **attrs):
         :rtype: :class:`~otcextensions.sdk.natv3.v3.transit_ip.PrivateTransitIp`
         """
         return self._create(_transit_ip.PrivateTransitIp, **attrs)
+
+    def delete_private_transit_ip(self, transit_ip, ignore_missing=True):
+        """Delete a private NAT transit IP address.
+
+        :param transit_ip: The value can be the ID of a transit IP address or a
+            :class:`~otcextensions.sdk.natv3.v3.transit_ip.PrivateTransitIp`
+            instance.
+        :param bool ignore_missing: When set to ``False``,
+            :class:`~openstack.exceptions.ResourceNotFound` will be raised when
+            the transit IP address does not exist. When set to ``True``, no
+            exception will be raised when attempting to delete a nonexistent
+            transit IP address.
+
+        :returns: ``None``
+        """
+        return self._delete(
+            _transit_ip.PrivateTransitIp, transit_ip, ignore_missing=ignore_missing
+        )
diff --git a/otcextensions/sdk/natv3/v3/transit_ip.py b/otcextensions/sdk/natv3/v3/transit_ip.py
@@ -23,9 +23,10 @@ class PrivateTransitIp(resource.Resource):
     base_path = "/private-nat/transit-ips"
 
     # capabilities
-    allow_fetch = True
     allow_list = True
+    allow_fetch = True
     allow_create = True
+    allow_delete = True
 
     _query_mapping = resource.QueryParameters(
         "limit",
diff --git a/otcextensions/sdk/rds/v3/instance.py b/otcextensions/sdk/rds/v3/instance.py
@@ -174,7 +174,7 @@ def _translate_response(
 
                 self._body.attributes.update(body_attrs)
                 self._body.clean()
-                if self.commit_jsonpatch or self.allow_patch:
+                if self.allow_patch:
                     # We need the original body to compare against
                     self._original_body = body_attrs.copy()
             except ValueError:
diff --git a/otcextensions/sdk/vpcep/v1/_proxy.py b/otcextensions/sdk/vpcep/v1/_proxy.py
diff --git a/otcextensions/sdk/vpcep/v1/endpoint.py b/otcextensions/sdk/vpcep/v1/endpoint.py
diff --git a/otcextensions/tests/functional/osclient/privatenat/v3/test_private_transit_ip.py b/otcextensions/tests/functional/osclient/privatenat/v3/test_private_transit_ip.py
diff --git a/otcextensions/tests/functional/privatenat.py b/otcextensions/tests/functional/privatenat.py
diff --git a/otcextensions/tests/functional/sdk/natv3/v3/test_private_transit_ip.py b/otcextensions/tests/functional/sdk/natv3/v3/test_private_transit_ip.py
diff --git a/otcextensions/tests/unit/osclient/privatenat/v3/test_transit_ip.py b/otcextensions/tests/unit/osclient/privatenat/v3/test_transit_ip.py
diff --git a/otcextensions/tests/unit/sdk/apig/v2/test_custom_authorizer.py b/otcextensions/tests/unit/sdk/apig/v2/test_custom_authorizer.py
diff --git a/otcextensions/tests/unit/sdk/dis/v2/test_dump_task.py b/otcextensions/tests/unit/sdk/dis/v2/test_dump_task.py
diff --git a/otcextensions/tests/unit/sdk/natv3/v3/test_proxy.py b/otcextensions/tests/unit/sdk/natv3/v3/test_proxy.py
diff --git a/otcextensions/tests/unit/sdk/natv3/v3/test_transit_ip.py b/otcextensions/tests/unit/sdk/natv3/v3/test_transit_ip.py
diff --git a/setup.cfg b/setup.cfg

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-otcextensions.sdk.vpecp.v1.connection`
	`1`	`+otcextensions.sdk.vpcep.v1.connection`
`2`	`2`	`=====================================`
`3`	`3`
`4`	`4`	`.. automodule:: otcextensions.sdk.vpcep.v1.connection`