openapi-generators · dbanty · Sep 25, 2021 · Sep 18, 2021 · Sep 18, 2021 · Sep 22, 2021
diff --git a/end_to_end_tests/golden-record/README.md b/end_to_end_tests/golden-record/README.md
@@ -41,6 +41,25 @@ my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
 response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
 ```
 
+By default when you're calling an https api it will attempt to verify that ssl is working correctly.
+Using certificate verification is highly recommended most of the time and is the default.
+But sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", 
+                             token="SuperSecretToken",
+                             verify_ssl='/path/to/certificate_bundle.pem')
+```
+
+or even disable ssl verification altogether, despite the fact that it can cause security risks.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", 
+                             token="SuperSecretToken", 
+                             verify_ssl=False)
+```
+but be careful with it.
+
 Things to know:
 1. Every path/method combo becomes a Python module with four functions:
     1. `sync`: Blocking request that returns parsed data (if successful) or `None`

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py
@@ -27,6 +27,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py
@@ -27,6 +27,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py b/...end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py
@@ -48,6 +48,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...den-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py b/...den-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py
@@ -28,6 +28,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py b/...golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py
@@ -28,6 +28,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py b/...golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py
@@ -36,6 +36,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py
@@ -26,6 +26,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py b/end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py
@@ -80,6 +80,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_booleans.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_booleans.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_floats.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_floats.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_integers.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_integers.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_strings.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_strings.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_user_list.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_user_list.py
@@ -44,6 +44,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/int_enum_tests_int_enum_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/int_enum_tests_int_enum_post.py
@@ -31,6 +31,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...to_end_tests/golden-record/my_test_api_client/api/tests/json_body_tests_json_body_post.py b/...to_end_tests/golden-record/my_test_api_client/api/tests/json_body_tests_json_body_post.py
@@ -26,6 +26,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "json": json_json_body,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py b/...end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...d_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py b/...d_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py
@@ -21,6 +21,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data.py
@@ -23,6 +23,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "data": form_data.to_dict(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/test_inline_objects.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/test_inline_objects.py
@@ -26,6 +26,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "json": json_json_body,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...olden-record/my_test_api_client/api/tests/token_with_cookie_auth_token_with_cookie_get.py b/...olden-record/my_test_api_client/api/tests/token_with_cookie_auth_token_with_cookie_get.py
@@ -23,6 +23,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py b/...-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py
@@ -20,6 +20,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py
@@ -30,6 +30,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "files": multipart_multipart_data,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/...sts/golden-record/my_test_api_client/api/tests/upload_multiple_files_tests_upload_post.py b/...sts/golden-record/my_test_api_client/api/tests/upload_multiple_files_tests_upload_post.py
@@ -33,6 +33,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "files": multipart_multipart_data,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/true_/false_.py b/end_to_end_tests/golden-record/my_test_api_client/api/true_/false_.py
@@ -27,6 +27,7 @@ def _get_kwargs(
         "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
+        "verify": client.verify_ssl,
     }
 
 

diff --git a/end_to_end_tests/golden-record/my_test_api_client/client.py b/end_to_end_tests/golden-record/my_test_api_client/client.py
@@ -1,4 +1,5 @@
-from typing import Dict
+import ssl
+from typing import Dict, Union
 
 import attr
 
@@ -11,6 +12,7 @@ class Client:
     cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
     headers: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
     timeout: float = attr.ib(5.0, kw_only=True)
+    verify_ssl: Union[str, bool, ssl.SSLContext] = attr.ib(True, kw_only=True)
 
     def get_headers(self) -> Dict[str, str]:
         """Get headers to be used in all endpoints"""

diff --git a/openapi_python_client/templates/README.md.jinja b/openapi_python_client/templates/README.md.jinja
@@ -41,6 +41,25 @@ my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
 response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
 ```
 
+By default when you're calling an https api it will attempt to verify that ssl is working correctly.
+Using certificate verification is highly recommended most of the time and is the default.
+But sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", 
+                             token="SuperSecretToken",
+                             verify_ssl='/path/to/certificate_bundle.pem')
+```
+
+or even disable ssl verification altogether, despite the fact that it can cause security risks.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", 
+                             token="SuperSecretToken", 
+                             verify_ssl=False)
+```
+but be careful with it.
+
 Things to know:
 1. Every path/method combo becomes a Python module with four functions:
     1. `sync`: Blocking request that returns parsed data (if successful) or `None`

diff --git a/openapi_python_client/templates/client.py.jinja b/openapi_python_client/templates/client.py.jinja
@@ -1,5 +1,5 @@
-from typing import Dict
-
+import ssl
+from typing import Dict, Union
 import attr
 
 @attr.s(auto_attribs=True)
@@ -10,6 +10,7 @@ class Client:
     cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
     headers: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
     timeout: float = attr.ib(5.0, kw_only=True)
+    verify_ssl: Union[str, bool, ssl.SSLContext] = attr.ib(True, kw_only=True)
 
     def get_headers(self) -> Dict[str, str]:
         """ Get headers to be used in all endpoints """

diff --git a/openapi_python_client/templates/endpoint_module.py.jinja b/openapi_python_client/templates/endpoint_module.py.jinja
@@ -52,6 +52,7 @@ def _get_kwargs(
         {% if endpoint.query_parameters %}
         "params": params,
         {% endif %}
+        "verify": client.verify_ssl,
     }