Merge branch 'main' into support-inline-form-data

Author: dbanty

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

@@ -13,14 +13,8 @@ jobs:
         with:
           fetch-depth: 0
           token: ${{ secrets.PAT }}
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-      - uses: Swatinem/rust-cache@v1
       - name: Install Knope
-        uses: actions-rs/cargo@v1
+        uses: knope-dev/action@v1
         with:
-          command: install
-          args: knope
+          version: 0.4.3
       - run: knope release --dry-run

.github/workflows/release.yml

@@ -17,16 +17,10 @@ jobs:
           git_user_signingkey: true
           git_commit_gpgsign: true
           git_push_gpgsign: false
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-      - uses: Swatinem/rust-cache@v1
       - name: Install Knope
-        uses: actions-rs/cargo@v1
+        uses: knope-dev/action@v1
         with:
-          command: install
-          args: knope
+          version: 0.4.3
       - name: Bump Version & Create GitHub Release
         run: knope release
         env:

CONTRIBUTING.md

@@ -32,7 +32,7 @@
 
 ## Creating a Pull Request
 
-Once you've written the code and run the checks, the next step is to create a pull request against the `main` branch of this repository. This repository uses [conventional commits] squashed on each PR, then uses [Dobby] to auto-generate CHANGELOG.md entries for release. So the title of your PR should be in the format of a conventional commit written in plain english as it will end up in the CHANGELOG. Some example PR titles:
+Once you've written the code and run the checks, the next step is to create a pull request against the `main` branch of this repository. This repository uses [conventional commits] squashed on each PR, then uses [Knope] to auto-generate CHANGELOG.md entries for release. So the title of your PR should be in the format of a conventional commit written in plain english as it will end up in the CHANGELOG. Some example PR titles:
 
 - feat: Support for `allOf` in OpenAPI documents (closes #123).
 - refactor!: Removed support for Python 3.5
@@ -45,4 +45,4 @@ Once your PR is created, a series of automated checks should run. If any of them
 As soon as possible, your PR will be reviewed. If there are any changes requested there will likely be a bit of back and forth. Once this process is done, your changes will be merged into main and included in the next release. If you need your changes available on PyPI by a certain time, please mention it in the PR, and we'll do our best to accommodate.
 
 [Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
-[Dobby]: https://triaxtec.github.io/dobby/introduction.html
+[Knope]: https://knope-dev.github.io/knope/

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

@@ -3,6 +3,8 @@
 import httpx
 
 from ...client import Client
+from ...models.get_location_header_types_int_enum_header import GetLocationHeaderTypesIntEnumHeader
+from ...models.get_location_header_types_string_enum_header import GetLocationHeaderTypesStringEnumHeader
 from ...types import UNSET, Response, Unset
 
 
@@ -13,6 +15,8 @@ def _get_kwargs(
     string_header: Union[Unset, str] = UNSET,
     number_header: Union[Unset, float] = UNSET,
     integer_header: Union[Unset, int] = UNSET,
+    int_enum_header: Union[Unset, GetLocationHeaderTypesIntEnumHeader] = UNSET,
+    string_enum_header: Union[Unset, GetLocationHeaderTypesStringEnumHeader] = UNSET,
 ) -> Dict[str, Any]:
     url = "{}/location/header/types".format(client.base_url)
 
@@ -31,6 +35,12 @@ def _get_kwargs(
     if not isinstance(integer_header, Unset):
         headers["Integer-Header"] = str(integer_header)
 
+    if not isinstance(int_enum_header, Unset):
+        headers["Int-Enum-Header"] = str(int_enum_header)
+
+    if not isinstance(string_enum_header, Unset):
+        headers["String-Enum-Header"] = str(string_enum_header)
+
     return {
         "method": "get",
         "url": url,
@@ -56,13 +66,17 @@ def sync_detailed(
     string_header: Union[Unset, str] = UNSET,
     number_header: Union[Unset, float] = UNSET,
     integer_header: Union[Unset, int] = UNSET,
+    int_enum_header: Union[Unset, GetLocationHeaderTypesIntEnumHeader] = UNSET,
+    string_enum_header: Union[Unset, GetLocationHeaderTypesStringEnumHeader] = UNSET,
 ) -> Response[Any]:
     """
     Args:
         boolean_header (Union[Unset, bool]):
         string_header (Union[Unset, str]):
         number_header (Union[Unset, float]):
         integer_header (Union[Unset, int]):
+        int_enum_header (Union[Unset, GetLocationHeaderTypesIntEnumHeader]):
+        string_enum_header (Union[Unset, GetLocationHeaderTypesStringEnumHeader]):
 
     Returns:
         Response[Any]
@@ -74,6 +88,8 @@ def sync_detailed(
         string_header=string_header,
         number_header=number_header,
         integer_header=integer_header,
+        int_enum_header=int_enum_header,
+        string_enum_header=string_enum_header,
     )
 
     response = httpx.request(
@@ -91,13 +107,17 @@ async def asyncio_detailed(
     string_header: Union[Unset, str] = UNSET,
     number_header: Union[Unset, float] = UNSET,
     integer_header: Union[Unset, int] = UNSET,
+    int_enum_header: Union[Unset, GetLocationHeaderTypesIntEnumHeader] = UNSET,
+    string_enum_header: Union[Unset, GetLocationHeaderTypesStringEnumHeader] = UNSET,
 ) -> Response[Any]:
     """
     Args:
         boolean_header (Union[Unset, bool]):
         string_header (Union[Unset, str]):
         number_header (Union[Unset, float]):
         integer_header (Union[Unset, int]):
+        int_enum_header (Union[Unset, GetLocationHeaderTypesIntEnumHeader]):
+        string_enum_header (Union[Unset, GetLocationHeaderTypesStringEnumHeader]):
 
     Returns:
         Response[Any]
@@ -109,6 +129,8 @@ async def asyncio_detailed(
         string_header=string_header,
         number_header=number_header,
         integer_header=integer_header,
+        int_enum_header=int_enum_header,
+        string_enum_header=string_enum_header,
     )
 
     async with httpx.AsyncClient(verify=client.verify_ssl) as _client:

end_to_end_tests/golden-record/my_test_api_client/models/__init__.py

@@ -19,6 +19,8 @@
 from .body_upload_file_tests_upload_post_some_optional_object import BodyUploadFileTestsUploadPostSomeOptionalObject
 from .different_enum import DifferentEnum
 from .free_form_model import FreeFormModel
+from .get_location_header_types_int_enum_header import GetLocationHeaderTypesIntEnumHeader
+from .get_location_header_types_string_enum_header import GetLocationHeaderTypesStringEnumHeader
 from .http_validation_error import HTTPValidationError
 from .import_ import Import
 from .model_from_all_of import ModelFromAllOf

end_to_end_tests/golden-record/my_test_api_client/models/get_location_header_types_int_enum_header.py

@@ -0,0 +1,10 @@
+from enum import IntEnum
+
+
+class GetLocationHeaderTypesIntEnumHeader(IntEnum):
+    VALUE_1 = 1
+    VALUE_2 = 2
+    VALUE_3 = 3
+
+    def __str__(self) -> str:
+        return str(self.value)

end_to_end_tests/golden-record/my_test_api_client/models/get_location_header_types_string_enum_header.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class GetLocationHeaderTypesStringEnumHeader(str, Enum):
+    ONE = "one"
+    TWO = "two"
+    THREE = "three"
+
+    def __str__(self) -> str:
+        return str(self.value)

end_to_end_tests/openapi.json

@@ -1090,6 +1090,32 @@
             },
             "name": "Integer-Header",
             "in": "header"
+          },
+          {
+            "in": "header",
+            "name": "Int-Enum-Header",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "enum": [
+                1,
+                2,
+                3
+              ]
+            }
+          },
+          {
+            "in": "header",
+            "name": "String-Enum-Header",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "one",
+                "two",
+                "three"
+              ]
+            }
           }
         ],
         "responses": {

openapi_python_client/parser/properties/enum_property.py

@@ -4,6 +4,7 @@
 
 import attr
 
+from ... import schema as oai
 from ... import utils
 from .property import Property
 from .schemas import Class
@@ -22,6 +23,13 @@ class EnumProperty(Property):
 
     template: ClassVar[str] = "enum_property.py.jinja"
 
+    _allowed_locations: ClassVar[Set[oai.ParameterLocation]] = {
+        oai.ParameterLocation.QUERY,
+        oai.ParameterLocation.PATH,
+        oai.ParameterLocation.COOKIE,
+        oai.ParameterLocation.HEADER,
+    }
+
     def get_base_type_string(self) -> str:
         return self.class_info.name
 

openapi_python_client/templates/property_templates/enum_property.py.jinja

@@ -33,3 +33,7 @@ if not isinstance({{ source }}, Unset):
 {% endif %}
 {% endif %}
 {% endmacro %}
+
+{% macro transform_header(property, source, destination) %}
+{{ destination }} = str({{ source }})
+{% endmacro %}