Merge branch 'main' into multiple_tags

Author: paulo-raca

.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/renovate.json

@@ -2,5 +2,28 @@
   "extends": [
     "config:base",
     ":semanticCommitTypeAll(chore)"
+  ],
+  "rangeStrategy": "widen",
+  "regexManagers": [
+    {
+      "fileMatch": [
+        "release.*\\.yml"
+      ],
+      "matchStrings": [
+        "version:\\s*(?<currentValue>.*)"
+      ],
+      "depNameTemplate": "knope",
+      "datasourceTemplate": "crate",
+      "versioningTemplate": "semver"
+    }
+  ],
+  "packageRules": [
+    {
+      "packagePatterns": [
+        "^knope$"
+      ],
+      "groupName": "knope",
+      "rangeStrategy": "pin"
+    }
   ]
 }

.github/workflows/checks.yml

@@ -5,12 +5,13 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+  merge_group:
 
 jobs:
   test:
     strategy:
       matrix:
-        python: [ "3.7", "3.8", "3.9", "3.10" ]
+        python: [ "3.8", "3.9", "3.10", "3.11" ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
@@ -22,7 +23,7 @@ jobs:
 
       - name: Get Python Version
         id: get_python_version
-        run: echo "::set-output name=python_version::$(python --version)"
+        run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT
 
       - name: Cache dependencies
         uses: actions/cache@v3
@@ -87,7 +88,7 @@ jobs:
           python-version: "3.10"
       - name: Get Python Version
         id: get_python_version
-        run: echo "::set-output name=python_version::$(python --version)"
+        run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:

.github/workflows/codeql-analysis.yml

@@ -8,6 +8,7 @@ on:
     branches: [main]
   schedule:
     - cron: '0 23 * * 2'
+  merge_group:
 
 jobs:
   analyze:

.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.6.2
+          version: 0.7.3
       - run: knope release --dry-run

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Knope
         uses: knope-dev/action@v1
         with:
-          version: 0.6.2
+          version: 0.7.3
       - name: Bump Version & Create GitHub Release
         run: knope release
         env:

CHANGELOG.md

@@ -13,6 +13,108 @@ 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.14.1
+
+### Fixes
+
+- Allow parameters named "client" and "url" [#758, #762, #765]. Thanks @truenicoco & @juanber84!
+
+## 0.14.0
+
+### Breaking Changes
+
+- Drop support for Python 3.7, put minimum version limit on Black (#754)
+
+### Features
+
+- Better typing (mypy) support for `Unset` (e.g., using if statements to check type) [#714, #752]. Thanks @taasan & @mcclurem! (#752)
+
+### Fixes
+
+- pyproject_no_poetry.toml.jinja template can be used to configure black and isort (closes #750) (#751)
+
+## 0.13.4
+
+### Features
+
+- support httpx 0.24 (#746)
+
+## 0.13.3
+
+### Features
+
+- Extend the UnexpectedStatus exception to include the response's content (#729)
+- Added support of follow HTTP redirects (#724). Thanks @expobrain & @emann!
+
+### Fixes
+
+- Parsing endpoint content types with semicolon separator (#727). Thanks @expobrain!
+- Remove Response[] from docstring of non-detailed functions (#741). Thanks @robertschweizer!
+
+## 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
+
+- Add `http_timeout` config to set timeout getting document via `--url` [#718]. Thanks @Kircheneer!
+
+## 0.13.0
+
+### Breaking Changes
+
+- run `post_hooks` in package directory instead of current directory if meta=none [#696, #697]. Thanks @brenmous and @wallagib!
+- Treat leading underscore as a sign of invalid identifier [#703]. Thanks @maxkomarychev!
+
+### Fixes
+
+- generated docstring for `Client.get_headers` function [#713]. Thanks @rtaycher!
+
+## 0.12.3
+
+### Features
+
+- Add `raise_on_unexpected_status` flag to generated `Client` [#593]. Thanks @JamesHinshelwood, @ramnes, @gwenshap, @theFong!
+- add `use_path_prefixes_for_title_model_names` config option for simpler model names [#559, #560]. Thanks @rtaycher!
+- Support any content type ending in `+json` [#706, #709]. Thanks @XioNoX and @mtovt!
+
+## 0.12.2
+
+### Fixes
+
+- Support Python 3.11.0 (#701)
+
+## 0.12.1
+
+### Fixes
+
+- Version bump due to PyPI error
+
+## 0.12.0
+
+### Breaking Changes
+
+- Change the `Response.status_code` type to the `HTTPStatus` enum [#665]
+
+### Features
+
+- Add `endpoint_collections_by_tag` and `openapi` to the templating globals [#689]. Thanks @paulo-raca!
+- Support for recursive and circular references using lazy imports [#670, #338, #466]. Thanks @maz808 & @mtovt!
+- Include `__all__` in generated `__init__.py` files [#676, #631, #540, #675]. Thanks @EltonChou!
+
+### Fixes
+
+- If data.type is None but has data.properties, assume type is object [#691, #674]. Thanks @ahuang11!
+
 ## 0.11.6
 
 ### Features

README.md

@@ -127,8 +127,7 @@ package_name_override: my_extra_special_package_name
 
 ### field_prefix
 
-When generating properties, the `name` attribute of the OpenAPI schema will be used. When the `name` is not a valid
-Python identifier (e.g. begins with a number) this string will be prepended. Defaults to "field\_".
+When generating properties, the `name` attribute of the OpenAPI schema will be used. When the `name` is not a valid Python identifier (e.g. begins with a number) this string will be prepended. Defaults to "field\_". It will also be used to prefix fields in schema starting with "_" in order to avoid ambiguous semantics.
 
 Example:
 
@@ -157,5 +156,17 @@ post_hooks:
    - "black ."
 ```
 
+### use_path_prefixes_for_title_model_names
+
+By default, `openapi-python-client` generates class names which include the full path to the schema, including any parent-types. This can result in very long class names like `MyRouteSomeClassAnotherClassResponse`—which is very unique and unlikely to cause conflicts with future API additions, but also super verbose.
+
+If you are carefully curating your `title` properties already to ensure no duplicate class names, you can turn off this prefixing feature by setting `use_path_prefixes_for_title_model_names` to `false` in your config file. This will use the `title` property of any object that has it set _without_ prefixing.
+
+If this option results in conflicts, you will need to manually override class names instead via the `class_overrides` option.
+
+### http_timeout
+
+By default, the timeout for retrieving the schema file via HTTP is 5 seconds. In case there is an error when retrieving the schema, you might try and increase this setting to a higher value.
+
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/

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

@@ -2,7 +2,7 @@
 
 import types
 
-from . import get_common_parameters, post_common_parameters
+from . import get_common_parameters, post_common_parameters, reserved_parameters
 
 
 class DefaultEndpoints:
@@ -13,3 +13,7 @@ def get_common_parameters(cls) -> types.ModuleType:
     @classmethod
     def post_common_parameters(cls) -> types.ModuleType:
         return post_common_parameters
+
+    @classmethod
+    def reserved_parameters(cls) -> types.ModuleType:
+        return reserved_parameters

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