feat: upgrade openapi-generator to v7.12.0 (#46)

The effects of this upgrade are:

- Clients will throw custom exceptions for HTTP 409 and HTTP 422
responses
- Clients can accept a `ca_cert_data` parameter
- List query parameters are encoded
- Fixed an issue with incorrect imports in model code that impacted the
`BulkPortRequest` model

The new version of openapi-generator also introduces a prefix on enum
values. To minimize the impact of this upgrade, the
`removeEnumValuePrefix` has been set to `true` in the generator config
file to disable the new generator behavior.

Author: ctreatma

Makefile

@@ -8,7 +8,7 @@ GIT_REPO=equinix-sdk-python
 PACKAGE_VERSION=$(shell cat version)
 USER_AGENT=${GIT_REPO}/${PACKAGE_VERSION}
 
-OPENAPI_IMAGE_TAG=v7.10.0
+OPENAPI_IMAGE_TAG=v7.12.0
 OPENAPI_IMAGE=openapitools/openapi-generator-cli:${OPENAPI_IMAGE_TAG}
 CRI=docker # nerdctl
 OPENAPI_GENERATOR=${CRI} run --rm -u ${CURRENT_UID}:${CURRENT_GID} -v $(CURDIR):/workdir -w /workdir ${OPENAPI_IMAGE}

config/openapi-generator.json

@@ -7,5 +7,6 @@
     "globalProperties": {
         "modelTests": false,
         "apiTests": false
-    }
+    },
+    "removeEnumValuePrefix": true
 }

equinix/services/fabricv4/api_client.py

@@ -513,7 +513,7 @@ def parameters_to_url_query(self, params, collection_formats):
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == 'multi':
-                    new_params.extend((k, str(value)) for value in v)
+                    new_params.extend((k, quote(str(value))) for value in v)
                 else:
                     if collection_format == 'ssv':
                         delimiter = ' '

equinix/services/fabricv4/configuration.py

@@ -14,7 +14,7 @@
 from logging import FileHandler
 import multiprocessing
 import sys
-from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict
+from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union
 from typing_extensions import NotRequired, Self
 
 import urllib3
@@ -157,6 +157,8 @@ class Configuration:
     :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
       in PEM format.
     :param retries: Number of retries for API requests.
+    :param ca_cert_data: verify the peer using concatenated CA certificate data
+      in PEM (str) or DER (bytes) format.
 
     :Example:
     """
@@ -171,13 +173,14 @@ def __init__(
         username: Optional[str]=None,
         password: Optional[str]=None,
         access_token: Optional[str]=None,
-        server_index: Optional[int]=None, 
+        server_index: Optional[int]=None,
         server_variables: Optional[ServerVariablesT]=None,
         server_operation_index: Optional[Dict[int, int]]=None,
         server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None,
         ignore_operation_servers: bool=False,
         ssl_ca_cert: Optional[str]=None,
         retries: Optional[int] = None,
+        ca_cert_data: Optional[Union[str, bytes]] = None,
         *,
         debug: Optional[bool] = None,
     ) -> None:
@@ -255,6 +258,10 @@ def __init__(
         self.ssl_ca_cert = ssl_ca_cert
         """Set this to customize the certificate file to verify the peer.
         """
+        self.ca_cert_data = ca_cert_data
+        """Set this to verify the peer using PEM (str) or DER (bytes)
+           certificate data.
+        """
         self.cert_file = None
         """client certificate file
         """

equinix/services/fabricv4/docs/BulkPortRequest.md

@@ -6,7 +6,7 @@ Create bulk port request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**List[PortRequest]**](Port.md) |  | [optional] 
+**data** | [**List[PortRequest]**](PortRequest.md) |  | [optional] 
 
 ## Example
 

equinix/services/fabricv4/docs/PortsApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 Add to Lag
 
-Add Physical Ports to Virtual Port.<font color=\"red\"> <sup color='red'>Preview</sup></font>
+Add Physical Ports to Virtual Port.<font color="red"> <sup color='red'>Preview</sup></font>
 
 ### Example
 
@@ -104,7 +104,7 @@ Name | Type | Description  | Notes
 
 Create Port
 
-Create Port creates Equinix Fabric? Port.<font color=\"red\"> <sup color='red'>Preview</sup></font>
+Create Port creates Equinix Fabric? Port.<font color="red"> <sup color='red'>Preview</sup></font>
 
 ### Example
 

equinix/services/fabricv4/exceptions.py

@@ -146,6 +146,13 @@ def from_response(
         if http_resp.status == 404:
             raise NotFoundException(http_resp=http_resp, body=body, data=data)
 
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
         if 500 <= http_resp.status <= 599:
             raise ServiceException(http_resp=http_resp, body=body, data=data)
         raise ApiException(http_resp=http_resp, body=body, data=data)
@@ -184,6 +191,16 @@ class ServiceException(ApiException):
     pass
 
 
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
 def render_path(path_to_item):
     """Returns a string representation of a path"""
     result = ""

equinix/services/fabricv4/models/bulk_port_request.py

@@ -15,15 +15,15 @@
 
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from equinix.services.fabricv4.models.port import Port
+from equinix.services.fabricv4.models.port_request import PortRequest
 from typing import Optional, Set
 from typing_extensions import Self
 
 class BulkPortRequest(BaseModel):
     """
     Create bulk port request
     """ # noqa: E501
-    data: Optional[List[Port]] = None
+    data: Optional[List[PortRequest]] = None
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["data"]
 
@@ -92,7 +92,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "data": [Port.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
+            "data": [PortRequest.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

equinix/services/fabricv4/rest.py

@@ -72,6 +72,7 @@ def __init__(self, configuration) -> None:
             "ca_certs": configuration.ssl_ca_cert,
             "cert_file": configuration.cert_file,
             "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
         }
         if configuration.assert_hostname is not None:
             pool_args['assert_hostname'] = (

equinix/services/fabricv4_README.md

@@ -5,7 +5,7 @@ The `equinix.services.fabricv4` package is automatically generated by the [OpenA
 
 - API version: 4.20
 - Package version: 0.8.0
-- Generator version: 7.10.0
+- Generator version: 7.12.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://docs.equinix.com/api-support.htm](https://docs.equinix.com/api-support.htm)