Merge branch 'main' into fix_content_type_with_semicolon_separator

Author: dbanty

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/openapi-generators/openapi-python-client/discussions
+    about: Please ask and answer questions here.
+  - name: Discord
+    url: https://discord.gg/JaqVvBgwYw
+    about: Less structured, more casual chat.

.github/workflows/release-dry-run.yml

@@ -12,9 +12,9 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          token: ${{ secrets.PAT }}
+          token: ${{ secrets.GITHUB_TOKEN }}
       - name: Install Knope
         uses: knope-dev/action@v1
         with:
-          version: 0.7.1
+          version: 0.7.2
       - run: knope release --dry-run

.github/workflows/release.yml

@@ -2,9 +2,6 @@ name: Release
 
 on: workflow_dispatch
 
-permissions:
-  contents: write
-
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -23,11 +20,11 @@ jobs:
       - name: Install Knope
         uses: knope-dev/action@v1
         with:
-          version: 0.7.1
+          version: 0.7.2
       - name: Bump Version & Create GitHub Release
         run: knope release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PAT }}
       - name: Install Poetry
         run: pip install --upgrade poetry
       - name: Push to PyPI

CHANGELOG.md

@@ -13,6 +13,17 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t
 
 The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2).
 
+## 0.13.2
+
+### Features
+
+- Always generate enums with sorted members (#728)
+
+### Fixes
+
+- Prevent backslashes in descriptions from breaking docstrings [#735]. Thanks @robertschweizer & @bryan-hunt! (#735)
+- Respect `required` field in parameters included with `$ref` (#737)
+
 ## 0.13.1
 
 ### Features

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/tests/__init__.py

@@ -5,6 +5,7 @@
 from . import (
     callback_test,
     defaults_tests_defaults_post,
+    description_with_backslash,
     get_basic_list_of_booleans,
     get_basic_list_of_floats,
     get_basic_list_of_integers,
@@ -158,3 +159,10 @@ def callback_test(cls) -> types.ModuleType:
         Try sending a request related to a callback
         """
         return callback_test
+
+    @classmethod
+    def description_with_backslash(cls) -> types.ModuleType:
+        """
+            Test description with \
+        """
+        return description_with_backslash

end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py

@@ -29,6 +29,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
         "params": params,
     }
 
@@ -37,7 +38,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any
     if response.status_code == HTTPStatus.OK:
         return None
     if client.raise_on_unexpected_status:
-        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+        raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
         return None
 

end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py

@@ -29,6 +29,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
         "params": params,
     }
 
@@ -37,7 +38,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any
     if response.status_code == HTTPStatus.OK:
         return None
     if client.raise_on_unexpected_status:
-        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+        raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
         return None
 

end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_header_types.py

@@ -49,14 +49,15 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
     }
 
 
 def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
     if response.status_code == HTTPStatus.OK:
         return None
     if client.raise_on_unexpected_status:
-        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+        raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
         return None
 

end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py

@@ -53,6 +53,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
         "params": params,
     }
 
@@ -61,7 +62,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any
     if response.status_code == HTTPStatus.OK:
         return None
     if client.raise_on_unexpected_status:
-        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+        raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
         return None
 

end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py

@@ -1,30 +1,32 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, Union
 
 import httpx
 
 from ... import errors
 from ...client import Client
-from ...types import UNSET, Response
+from ...types import UNSET, Response, Unset
 
 
 def _get_kwargs(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Dict[str, Any]:
     url = "{}/parameter-references/{path_param}".format(client.base_url, path_param=path_param)
 
     headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
-    headers["header param"] = header_param
+    if not isinstance(header_param, Unset):
+        headers["header param"] = header_param
 
-    cookies["cookie param"] = cookie_param
+    if cookie_param is not UNSET:
+        cookies["cookie param"] = cookie_param
 
     params: Dict[str, Any] = {}
     params["string param"] = string_param
@@ -39,6 +41,7 @@ def _get_kwargs(
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
         "params": params,
     }
 
@@ -47,7 +50,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any
     if response.status_code == HTTPStatus.OK:
         return None
     if client.raise_on_unexpected_status:
-        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+        raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
         return None
 
@@ -65,19 +68,19 @@ def sync_detailed(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
 
     Args:
         path_param (str):
-        string_param (str):
-        integer_param (int):
-        header_param (str):
-        cookie_param (str):
+        string_param (Union[Unset, None, str]):
+        integer_param (Union[Unset, None, int]):
+        header_param (Union[Unset, str]):
+        cookie_param (Union[Unset, str]):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -108,19 +111,19 @@ async def asyncio_detailed(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
 
     Args:
         path_param (str):
-        string_param (str):
-        integer_param (int):
-        header_param (str):
-        cookie_param (str):
+        string_param (Union[Unset, None, str]):
+        integer_param (Union[Unset, None, int]):
+        header_param (Union[Unset, str]):
+        cookie_param (Union[Unset, str]):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.