Merge branch 'main' into live-generated-code-tests

# Conflicts:
#	end_to_end_tests/test_end_to_end.py

Author: dbanty

.changeset/always_parse_ref_as_a_reference.md

@@ -0,0 +1,11 @@
+---
+default: patch
+---
+
+# Always parse `$ref` as a reference
+
+If additional attributes were included with a `$ref` (for example `title` or `description`), the property could be 
+interpreted as a new type instead of a reference, usually resulting in `Any` in the generated code.
+Now, any sibling properties to `$ref` will properly be ignored, as per the OpenAPI specification.
+
+Thanks @nkrishnaswami!

.changeset/drop_support_for_python_38.md

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.2.2
       - name: Set up Python
-        uses: actions/setup-python@v5.3.0
+        uses: actions/setup-python@v5.4.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -51,27 +51,62 @@ jobs:
       - name: Run pytest without coverage
         if: matrix.os != 'ubuntu-latest'
         run: pdm test
-        env:
-          TASKIPY: true
 
       - name: Run pytest with coverage
         if: matrix.os == 'ubuntu-latest'
         run: pdm test_with_coverage
-        env:
-          TASKIPY: true
-      
+
       - run: mv .coverage .coverage.${{ matrix.python }}
         if: matrix.os == 'ubuntu-latest'
 
       - name: Store coverage report
-        uses: actions/upload-artifact@v4.4.3
+        uses: actions/upload-artifact@v4.6.1
         if: matrix.os == 'ubuntu-latest'
         with:
           name: coverage-${{ matrix.python }}
           path: .coverage.${{ matrix.python }}
           if-no-files-found: error
           include-hidden-files: true
 
+  test_min_deps:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - name: Set up Python
+        uses: actions/setup-python@v5.4.0
+        with:
+          python-version: "3.9"
+
+      - name: Get Python Version
+        id: get_python_version
+        run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-min-dependencies-${{ hashFiles('**/pdm.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-min-dependencies
+      - name: Install PDM
+        run: pip install pdm
+
+      - name: Install minimum dependencies
+        run: pdm install -L pdm.minimal.lock
+
+      - name: Run mypy
+        run: pdm mypy --show-error-codes
+
+      - name: Lint
+        run: pdm run ruff check .
+
+      - name: Run unit tests only  # snapshots are expected to fail
+        run: pdm unit_test
+
   coverage:
     name: Combine & check coverage
     needs: test
@@ -82,7 +117,7 @@ jobs:
         with:
           python-version: "3.12"
       - name: Download coverage reports
-        uses: actions/download-artifact@v4.1.8
+        uses: actions/download-artifact@v4.1.9
         with:
           merge-multiple: true
 
@@ -107,7 +142,7 @@ jobs:
           .venv/bin/python -m coverage report --fail-under=100          
 
       - name: Upload HTML report if check failed.
-        uses: actions/upload-artifact@v4.4.3
+        uses: actions/upload-artifact@v4.6.1
         with:
           name: html-report
           path: htmlcov
@@ -129,7 +164,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.2.2
       - name: Set up Python
-        uses: actions/setup-python@v5.3.0
+        uses: actions/setup-python@v5.4.0
         with:
           python-version: "3.9"
       - name: Get Python Version

.changeset/type_is_now_a_reserved_field_name.md

@@ -18,6 +18,6 @@ jobs:
       - name: Build
         run: hatchling build
       - name: Push to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.2
+        uses: pypa/gh-action-pypi-publish@v1.12.4
         with:
             attestations: true

.github/workflows/checks.yml

@@ -13,6 +13,94 @@ 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.24.0 (2025-03-03)
+
+### Breaking Changes
+
+#### Support `$ref` in responses
+
+Previously, using a `$ref` to define a response was ignored, the code to call the endpoint was still generated, but 
+the response would not be parsed. Now, responses defined with `$ref` will be used to generate the response model, which 
+will parse the response at runtime.
+
+If a `$ref` is incorrect or uses a feature that is not supported by the generator, these endpoints will start failing to 
+generate.
+
+### Features
+
+#### Make `config` available in custom templates
+
+The configuration options object is now exposed as a variable called `config` in Jinja2 templates.
+
+#### Add `docstrings_on_attributes` config setting
+
+Setting this option to `true` changes the docstring behavior in model classes: for any attribute that have a non-empty `description`, instead of describing the attribute as part of the class's docstring, the description will appear in an individual docstring for that attribute.
+
+## 0.23.1 (2025-01-13)
+
+### Features
+
+- allow Ruff 0.9 (#1192)
+
+## 0.23.0 (2024-12-24)
+
+### Breaking Changes
+
+#### Delete fewer files with `--overwrite`
+
+`--overwrite` will no longer delete the entire output directory before regenerating. Instead, it will only delete 
+specific, known directories within that directory. Right now, that is only the generated `models` and `api` directories.
+
+Other generated files, like `README.md`, will be overwritten. Extra files and directories outside of those listed above 
+will be left untouched, so you can any extra modules or files around while still updating `pyproject.toml` automatically.
+
+Closes #1105.
+
+### Features
+
+- Support httpx 0.28 (#1172)
+
+#### Add `generate_all_tags` config option
+
+You can now, optionally, generate **duplicate** endpoint functions/modules using _every_ tag for an endpoint,
+not just the first one, by setting `generate_all_tags: true` in your configuration file.
+
+### Fixes
+
+- Support Typer 0.14 and 0.15 (#1173)
+
+#### Fix minimum `attrs` version
+
+The minimum `attrs` dependency version was incorrectly set to 21.3.0. This has been corrected to 22.2.0, the minimum 
+supported version since `openapi-python-client` 0.19.1.
+
+Closes #1084, thanks @astralblue!
+
+#### Fix compatibility with Pydantic 2.10+
+
+##1176 by @Viicos
+
+Set `defer_build` to models that we know will fail to build, and call `model_rebuild`
+in the `__init__.py` file.
+
+## 0.22.0 (2024-11-23)
+
+### Breaking Changes
+
+#### Drop support for Python 3.8
+
+Python 3.8 is no longer supported. "New" 3.9 syntax, like generics on builtin collections, is used both in the generator 
+and the generated code.
+
+#### `type` is now a reserved field name
+
+Because `type` is used in type annotations now, it is no longer a valid field name. Fields which were previously named 
+`type` will be renamed to `type_`.
+
+### Features
+
+- Support Ruff 0.8 (#1169)
+
 ## 0.21.7 (2024-10-28)
 
 ### Fixes

.github/workflows/release.yml

@@ -97,6 +97,16 @@ class_overrides:
 
 The easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the `models` folder.
 
+### docstrings_on_attributes
+
+By default, when `openapi-python-client` generates a model class, it includes a list of attributes and their
+descriptions in the docstring for the class. If you set this option to `true`, then the attribute descriptions
+will be put in docstrings for the attributes themselves, and will not be in the class docstring.
+
+```yaml
+docstrings_on_attributes: true
+```
+
 ### literal_enums
 
 By default, `openapi-python-client` generates classes inheriting for `Enum` for enums. It can instead use `Literal` 
@@ -108,6 +118,16 @@ literal_enums: true
 
 This is especially useful if enum values, when transformed to their Python names, end up conflicting due to case sensitivity or special symbols.
 
+### generate_all_tags
+
+`openapi-python-client` generates module names within the `api` module based on the OpenAPI `tags` of each endpoint. 
+By default, only the _first_ tag is generated. If you want to generate **duplicate** endpoint functions using _every_ tag 
+listed, you can enable this option:
+
+```yaml
+generate_all_tags: true
+```
+
 ### project_name_override and package_name_override
 
 Used to change the name of generated client library project/package. If the project name is changed but an override for the package name

CHANGELOG.md

@@ -1,4 +1,18 @@
 # serializer version: 1
+# name: test_documents_with_errors[bad-status-code]
+  '''
+  Generating /test-documents-with-errors
+  Warning(s) encountered while generating. Client was generated, but some pieces may be missing
+  
+  WARNING parsing GET / within default.
+  
+  Invalid response status code abcdef (not a valid HTTP status code), response will be omitted from generated client
+  
+  
+  If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
+  
+  '''
+# ---
 # name: test_documents_with_errors[circular-body-ref]
   '''
   Generating /test-documents-with-errors

README.md

@@ -394,7 +394,16 @@
           "content": {
             "multipart/form-data": {
               "schema": {
-                "$ref": "#/components/schemas/Body_upload_file_tests_upload_post"
+                "$ref": "#/components/schemas/Body_upload_file_tests_upload_post",
+                "title": "Body_upload_file_tests_upload_post",
+                "required": [
+                  "some_file",
+                  "some_object",
+                  "some_nullable_object",
+                  "some_required_number"
+                ],
+                "properties": {
+                }
               }
             }
           },
@@ -991,6 +1000,20 @@
         }
       }
     },
+    "/responses/reference": {
+      "get": {
+        "tags": [
+          "responses"
+        ],
+        "summary": "Endpoint using predefined response",
+        "operationId": "reference_response",
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/AResponse"
+          }
+        }
+      }
+    },
     "/auth/token_with_cookie": {
       "get": {
         "tags": [
@@ -1149,9 +1172,7 @@
     },
     "/tag_with_number": {
       "get": {
-        "tags": [
-          "1"
-        ],
+        "tags": ["1", "2"],
         "responses": {
           "200": {
             "description": "Success"
@@ -2971,6 +2992,18 @@
           }
         }
       }
+    },
+    "responses": {
+      "AResponse": {
+        "description": "OK",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/AModel"
+            }
+          }
+        }
+      }
     }
   }
 }