cadwyn 4.4.5__tar.gz → 4.6.0__tar.gz

{cadwyn-4.4.5 → cadwyn-4.6.0}/.github/actions/setup-python-uv/action.yaml

@@ -8,7 +8,7 @@ inputs:
   uv-version:
     description: "The uv version to set up"
     required: true
-    default: "0.4.18"
+    default: "0.5.8"
 
 runs:
   using: "composite"
@@ -16,12 +16,12 @@ runs:
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
-    - uses: astral-sh/setup-uv@v3
+    - uses: astral-sh/setup-uv@v5
       with:
         version: ${{ inputs.uv-version }}
         enable-cache: true
         cache-dependency-glob: "uv.lock"
     - run: |
         uv sync --frozen --all-extras --dev
-        echo "$(pwd)/.venv/bin" >> $GITHUB_PATH
+        uv pip install --system tox tox-uv
       shell: bash

{cadwyn-4.4.5 → cadwyn-4.6.0}/.github/workflows/ci.yaml

@@ -10,7 +10,7 @@ on:
     branches: [main, 3.x.x]
     types: [opened, synchronize]
     paths:
-      - ".github/workflows/ci.yaml"  # self
+      - ".github/workflows/ci.yaml" # self
       - "**.py"
       - "**.toml"
       - "**.lock"
@@ -41,13 +41,13 @@ jobs:
       - uses: ./.github/actions/setup-python-uv
         with:
           python-version: ${{ matrix.python-version }}
-      - run: uv run coverage run --source=. --parallel-mode -m pytest tests
+      - run: tox run -e py
       - name: Upload coverage results
         uses: actions/upload-artifact@v4
         if: matrix.os == 'ubuntu-latest' # Cross-platform coverage combination doesn't work
         with:
           name: coverage-results-${{ matrix.python-version }}
-          path: coverage/
+          path: .coverage*
   Tutorial-tests:
     runs-on: ubuntu-latest
     name: Tutorial tests
@@ -58,13 +58,15 @@ jobs:
           python-version: "3.10"
       - name: Install cadwyn with instructions from docs
         run: sh docs_src/quickstart/setup/block001.sh
-      - run: pip install pytest coverage dirty-equals
-      - run: coverage run --source=. --parallel-mode -m pytest docs_src
+      - run: |
+          pip install uv
+          uv pip install --system pytest coverage dirty-equals
+          coverage run -m pytest docs_src
       - name: Upload coverage results
         uses: actions/upload-artifact@v4
         with:
           name: coverage-results-docs
-          path: coverage/
+          path: .coverage*
   Coverage:
     needs: [Tests, Tutorial-tests]
     runs-on: ubuntu-latest
@@ -75,32 +77,56 @@ jobs:
         with:
           pattern: coverage-results-*
           merge-multiple: true
-          path: coverage/
+          path: .
       - uses: actions/setup-python@v5
         with:
           python-version: "3.10"
-      - run: pip install 'coverage[toml]'
-      - run: coverage combine
-      - run: coverage xml
+      - run: |
+          pip install uv
+          uv pip install --system tox tox-uv
+          tox run -e coverage_report-ci
       - name: Upload to Codecov
         uses: codecov/codecov-action@v4
         env:
           fail_ci_if_error: true
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-      - run: coverage report --fail-under=100 --show-missing
 
   Lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pre-commit/action@v3.0.0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - run: |
+          python -m pip install uv
+          uv pip install --system pre-commit pre-commit-uv
+          pre-commit run --all-files
 
-  Typecheck:
+  Validate-links:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-python-uv
+        with:
+          # When this version is updated,
+          # update the pyright `base_python` version in `tox.ini`, too.
+          python-version: "3.10"
+      - run: tox run -e docs
+      - name: Validate links
+        uses: umbrelladocs/action-linkspector@v1
+        with:
+          reporter: github-pr-review
+          filter_mode: diff_context
+          fail_level: any
 
-      - uses: jakebailey/pyright-action@v1
+  Typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-python-uv
         with:
-          pylance-version: latest-release
+          # When this version is updated,
+          # update the pyright `base_python` version in `tox.ini`, too.
+          python-version: "3.10"
+      - run: tox run -e pyright

{cadwyn-4.4.5 → cadwyn-4.6.0}/.github/workflows/daily_tests.yaml

@@ -21,10 +21,8 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - run: uv sync --refresh --all-extras --dev --upgrade
-      - run: pytest .
-      - uses: jakebailey/pyright-action@v1
-        with:
-          pylance-version: latest-release
+      - run: uv run pytest . # We intentionally don't use tox here to run tests "as is"
+      - run: uv run pyright --version && uv run pyright .
 
   notify-on-failure:
     name: Notify on failure

{cadwyn-4.4.5 → cadwyn-4.6.0}/CHANGELOG.md

@@ -5,6 +5,20 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [4.6.0]
+
+### Added
+
+* Support for more field attributes in `schema.had()` and `schema.didnt_have()`: `field_title_generator`, `fail_fast`, `coerce_numbers_to_str`, `union_mode`, `allow_mutation`, `pattern`, `discriminator`
+* Support for forwardrefs in body fields (for example, when you use `from __future__ import annotations` in the file with your routes)
+* Support for forwardrefs in route dependencies
+
+## [4.5.0]
+
+### Added
+
+* `check_usage` argument to request/response by schema converters. Cadwyn always checks whether a schema mentioned in a converter applies to one or more endpoints to guarantee that the converter will apply to at least one endpoint. Sometimes, however, you do not need this validation. For example, when you use these converters for converting webhook bodies. Setting `check_usage=False` makes it possible to skip the validation
+
 ## [4.4.5]
 
 ### Fixed

cadwyn-4.6.0/Makefile

@@ -0,0 +1,11 @@
+SHELL := /bin/bash
+py_warn = PYTHONDEVMODE=1
+
+install:
+	uv sync --all-extras --dev
+
+lint:
+	pre-commit run --all-files
+
+test:
+	uv run --with tox --with tox-uv tox

{cadwyn-4.4.5 → cadwyn-4.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cadwyn
-Version: 4.4.5
+Version: 4.6.0
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Project-URL: Source code, https://github.com/zmievsa/cadwyn
 Project-URL: Documentation, https://docs.cadwyn.dev

{cadwyn-4.4.5 → cadwyn-4.6.0}/cadwyn/applications.py

@@ -279,7 +279,7 @@ class Cadwyn(FastAPI):
         except (ValueError, TypeError):
             version = raw_version
 
-        if version in self.router.versioned_routers:
+        if isinstance(version, date) and version in self.router.versioned_routers:
             routes = self.router.versioned_routers[version].routes
             formatted_version = version.isoformat()
         elif version == "unversioned" and self._there_are_public_unversioned_routes():
@@ -296,7 +296,7 @@ class Cadwyn(FastAPI):
             self.servers.insert(0, {"url": root_path})
 
         webhook_routes = None
-        if version in self._versioned_webhook_routers:
+        if isinstance(version, date) and version in self._versioned_webhook_routers:
             webhook_routes = self._versioned_webhook_routers[version].routes
 
         return JSONResponse(

{cadwyn-4.4.5 → cadwyn-4.6.0}/cadwyn/route_generation.py

@@ -221,6 +221,8 @@ class _EndpointTransformer(Generic[_R, _WR]):
 
             for by_schema_converters in version_change.alter_request_by_schema_instructions.values():
                 for by_schema_converter in by_schema_converters:
+                    if not by_schema_converter.check_usage:  # pragma: no cover
+                        continue
                     missing_models = set(by_schema_converter.schemas) - head_request_bodies
                     if missing_models:
                         raise RouteRequestBySchemaConverterDoesNotApplyToAnythingError(
@@ -232,6 +234,8 @@ class _EndpointTransformer(Generic[_R, _WR]):
                         )
             for by_schema_converters in version_change.alter_response_by_schema_instructions.values():
                 for by_schema_converter in by_schema_converters:
+                    if not by_schema_converter.check_usage:  # pragma: no cover
+                        continue
                     missing_models = set(by_schema_converter.schemas) - head_response_models
                     if missing_models:
                         raise RouteResponseBySchemaConverterDoesNotApplyToAnythingError(
@@ -240,6 +244,9 @@ class _EndpointTransformer(Generic[_R, _WR]):
                             f"failed to find routes with the following response models: "
                             f"{[m.__name__ for m in missing_models]}. "
                             f"This means that you are trying to apply this converter to non-existing endpoint(s). "
+                            "If this is intentional and this converter really does not apply to any endpoints, then "
+                            "pass check_usage=False argument to "
+                            f"{version_change.__name__}.{by_schema_converter.transformer.__name__}"
                         )
 
     def _extract_all_routes_identifiers(

{cadwyn-4.4.5 → cadwyn-4.6.0}/cadwyn/schema_generation.py

@@ -40,6 +40,7 @@ from pydantic._internal._decorators import (
     RootValidatorDecoratorInfo,
     ValidatorDecoratorInfo,
 )
+from pydantic._internal._typing_extra import try_eval_type as pydantic_try_eval_type
 from pydantic.fields import ComputedFieldInfo, FieldInfo
 from typing_extensions import Doc, Self, _AnnotatedAlias, assert_never
 
@@ -158,7 +159,7 @@ def migrate_response_body(
     *,
     latest_body: Any,
     version: VersionDate | str,
-):
+) -> Any:
     """Convert the data to a specific version
 
     Apply all version changes from latest until the passed version in reverse order
@@ -231,6 +232,12 @@ def _is_dunder(attr_name: str):
 
 
 def _wrap_pydantic_model(model: type[_T_PYDANTIC_MODEL]) -> "_PydanticModelWrapper[_T_PYDANTIC_MODEL]":
+    # In case we have a forwardref within one of the fields
+    # For example, when "from __future__ import annotations" is used in the file with the schema
+    if model is not BaseModel:
+        model.model_rebuild(raise_errors=False)
+    model = cast(type[_T_PYDANTIC_MODEL], model)
+
     decorators = _get_model_decorators(model)
     validators = {}
     for decorator_wrapper in decorators:
@@ -239,8 +246,20 @@ def _wrap_pydantic_model(model: type[_T_PYDANTIC_MODEL]) -> "_PydanticModelWrapp
 
         wrapped_validator = _wrap_validator(decorator_wrapper.func, decorator_wrapper.shim, decorator_wrapper.info)
         validators[decorator_wrapper.cls_var_name] = wrapped_validator
+
+    annotations = {
+        name: value
+        if not isinstance(value, str)
+        else model.model_fields[name].annotation or model.__annotations__[name]
+        for name, value in model.__annotations__.items()
+    }
+
     fields = {
-        field_name: PydanticFieldWrapper(model.model_fields[field_name], model.__annotations__[field_name], field_name)
+        field_name: PydanticFieldWrapper(
+            model.model_fields[field_name],
+            annotations[field_name],
+            field_name,
+        )
         for field_name in model.__annotations__
     }
 
@@ -263,7 +282,7 @@ def _wrap_pydantic_model(model: type[_T_PYDANTIC_MODEL]) -> "_PydanticModelWrapp
         fields=fields,
         other_attributes=other_attributes,
         validators=validators,
-        annotations=model.__annotations__.copy(),
+        annotations=annotations,
     )
 
 
@@ -355,6 +374,7 @@ class _PydanticModelWrapper(Generic[_T_PYDANTIC_MODEL]):
             if not validator.is_deleted and type(validator) == _ValidatorWrapper  # noqa: E721
         }
         fields = {name: field.generate_field_copy(generator) for name, field in self.fields.items()}
+
         model_copy = type(self.cls)(
             self.name,
             tuple(generator[cast(type[BaseModel], base)] for base in self.cls.__bases__),
@@ -418,6 +438,7 @@ class _AnnotationTransformer:
         # because such copies could produce weird behaviors at runtime, especially if you/fastapi do any comparisons.
         # It's defined here and not on the method because of this: https://youtu.be/sVjtp6tGo0g
         self.generator = generator
+        # TODO: Rewrite this to memoize
         self.change_versions_of_a_non_container_annotation = functools.cache(
             self._change_version_of_a_non_container_annotation
         )
@@ -531,6 +552,9 @@ class _AnnotationTransformer:
         annotation_modifying_wrapper = annotation_modifying_wrapper_factory(call)
         old_params = inspect.signature(call).parameters
         callable_annotations = annotation_modifying_wrapper.__annotations__
+        callable_annotations = {
+            k: v if type(v) is not str else _try_eval_type(v, call.__globals__) for k, v in callable_annotations.items()
+        }
         annotation_modifying_wrapper.__annotations__ = modify_annotations(callable_annotations)
         annotation_modifying_wrapper.__defaults__ = modify_defaults(
             tuple(p.default for p in old_params.values() if p.default is not inspect.Signature.empty),
@@ -631,8 +655,6 @@ class SchemaGenerator:
 
         if model in self.concrete_models:
             return self.concrete_models[model]
-        else:
-            wrapper = self._get_wrapper_for_model(model)
 
         wrapper = self._get_wrapper_for_model(model)
         model_copy = wrapper.generate_model_copy(self)
@@ -655,6 +677,8 @@ class SchemaGenerator:
             return self.model_bundle.enums[model]
 
         if lenient_issubclass(model, BaseModel):
+            # TODO: My god, what if one of its fields is in our concrete schemas and we don't use it? :O
+            # TODO: Add an argument with our concrete schemas for _wrap_pydantic_model
             wrapper = _wrap_pydantic_model(model)
             self.model_bundle.schemas[model] = wrapper
         elif lenient_issubclass(model, Enum):
@@ -977,3 +1001,11 @@ class _EnumWrapper(Generic[_T_ENUM]):
             and k not in _DummyEnum.__dict__
             and (k not in mro_dict or mro_dict[k] is not v)
         }
+
+
+def _try_eval_type(value: Any, globals: dict[str, Any]) -> Any:
+    new_value, success = pydantic_try_eval_type(value, globals)
+    if success:
+        return new_value
+    else:  # pragma: no cover # Can't imagine when this would happen
+        return value

{cadwyn-4.4.5 → cadwyn-4.6.0}/cadwyn/structure/data.py

@@ -86,6 +86,12 @@ class _AlterDataInstruction:
         return self.transformer(__request_or_response)
 
 
+@dataclass
+class _BaseAlterBySchemaInstruction:
+    schemas: tuple[Any, ...]
+    check_usage: bool = True
+
+
 ##########
 # Requests
 ##########
@@ -97,8 +103,7 @@ class _BaseAlterRequestInstruction(_AlterDataInstruction):
 
 
 @dataclass
-class _AlterRequestBySchemaInstruction(_BaseAlterRequestInstruction):
-    schemas: tuple[Any, ...]
+class _AlterRequestBySchemaInstruction(_BaseAlterBySchemaInstruction, _BaseAlterRequestInstruction): ...
 
 
 @dataclass
@@ -110,7 +115,10 @@ class _AlterRequestByPathInstruction(_BaseAlterRequestInstruction):
 
 @overload
 def convert_request_to_next_version_for(
-    first_schema: type, /, *additional_schemas: type
+    first_schema: type,
+    /,
+    *additional_schemas: type,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]": ...
 
 
@@ -123,6 +131,7 @@ def convert_request_to_next_version_for(
     methods_or_second_schema: list[str] | None | type = None,
     /,
     *additional_schemas: type,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]":
     _validate_decorator_args(schema_or_path, methods_or_second_schema, additional_schemas)
 
@@ -141,6 +150,7 @@ def convert_request_to_next_version_for(
             return _AlterRequestBySchemaInstruction(
                 schemas=schemas,
                 transformer=transformer,
+                check_usage=check_usage,
             )
 
     return decorator  # pyright: ignore[reportReturnType]
@@ -158,8 +168,7 @@ class _BaseAlterResponseInstruction(_AlterDataInstruction):
 
 
 @dataclass
-class _AlterResponseBySchemaInstruction(_BaseAlterResponseInstruction):
-    schemas: tuple[Any, ...]
+class _AlterResponseBySchemaInstruction(_BaseAlterBySchemaInstruction, _BaseAlterResponseInstruction): ...
 
 
 @dataclass
@@ -175,6 +184,7 @@ def convert_response_to_previous_version_for(
     /,
     *schemas: type,
     migrate_http_errors: bool = False,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]": ...
 
 
@@ -194,6 +204,7 @@ def convert_response_to_previous_version_for(
     /,
     *additional_schemas: type,
     migrate_http_errors: bool = False,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]":
     _validate_decorator_args(schema_or_path, methods_or_second_schema, additional_schemas)
 
@@ -215,6 +226,7 @@ def convert_response_to_previous_version_for(
                 schemas=schemas,
                 transformer=transformer,
                 migrate_http_errors=migrate_http_errors,
+                check_usage=check_usage,
             )
 
     return decorator  # pyright: ignore[reportReturnType]

{cadwyn-4.4.5 → cadwyn-4.6.0}/cadwyn/structure/schemas.py

@@ -3,7 +3,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Literal, cast
 
 from issubclass import issubclass as lenient_issubclass
-from pydantic import BaseModel, Field
+from pydantic import AliasChoices, AliasPath, BaseModel, Field
 from pydantic._internal._decorators import PydanticDescriptorProxy, unwrap_wrapped_function
 from pydantic.fields import FieldInfo
 
@@ -18,58 +18,83 @@ if TYPE_CHECKING:
 
 PossibleFieldAttributes = Literal[
     "default",
-    "default_factory",
     "alias",
+    "alias_priority",
+    "default_factory",
+    "validation_alias",
+    "serialization_alias",
     "title",
+    "field_title_generator",
     "description",
+    "examples",
     "exclude",
     "const",
+    "deprecated",
+    "frozen",
+    "validate_default",
+    "repr",
+    "init",
+    "init_var",
+    "kw_only",
+    "fail_fast",
     "gt",
     "ge",
     "lt",
     "le",
-    "deprecated",
-    "fail_fast",
     "strict",
+    "coerce_numbers_to_str",
     "multiple_of",
     "allow_inf_nan",
     "max_digits",
     "decimal_places",
     "min_length",
     "max_length",
+    "union_mode",
     "allow_mutation",
     "pattern",
     "discriminator",
-    "repr",
 ]
 
 
+# TODO: Add json_schema_extra as a breaking change in a major version
 @dataclass(slots=True)
 class FieldChanges:
     default: Any
+    alias: str | None
     default_factory: Any
-    alias: str
-    title: str
+    alias_priority: int | None
+    validation_alias: str | AliasPath | AliasChoices | None
+    serialization_alias: str | None
+    title: str | None
+    field_title_generator: Callable[[str, FieldInfo], str] | None
     description: str
+    examples: list[Any] | None
     exclude: "AbstractSetIntStr | MappingIntStrAny | Any"
     const: bool
     deprecated: bool
+    frozen: bool | None
+    validate_default: bool | None
+    repr: bool
+    init: bool | None
+    init_var: bool | None
+    kw_only: bool | None
     fail_fast: bool
     gt: float
     ge: float
     lt: float
     le: float
     strict: bool
+    coerce_numbers_to_str: bool | None
     multiple_of: float
     allow_inf_nan: bool
     max_digits: int
     decimal_places: int
     min_length: int
     max_length: int
+    union_mode: Literal["smart", "left_to_right"]
     allow_mutation: bool
     pattern: str
     discriminator: str
-    repr: bool
 
 
 @dataclass(slots=True)
@@ -113,29 +138,41 @@ class AlterFieldInstructionFactory:
         name: str = Sentinel,
         type: Any = Sentinel,
         default: Any = Sentinel,
+        alias: str | None = Sentinel,
         default_factory: Callable = Sentinel,
-        alias: str = Sentinel,
+        alias_priority: int = Sentinel,
+        validation_alias: str = Sentinel,
+        serialization_alias: str = Sentinel,
         title: str = Sentinel,
+        field_title_generator: Callable[[str, FieldInfo], str] = Sentinel,
         description: str = Sentinel,
+        examples: list[Any] = Sentinel,
         exclude: "AbstractSetIntStr | MappingIntStrAny | Any" = Sentinel,
         const: bool = Sentinel,
+        deprecated: bool = Sentinel,
+        frozen: bool = Sentinel,
+        validate_default: bool = Sentinel,
+        repr: bool = Sentinel,
+        init: bool = Sentinel,
+        init_var: bool = Sentinel,
+        kw_only: bool = Sentinel,
+        fail_fast: bool = Sentinel,
         gt: float = Sentinel,
         ge: float = Sentinel,
         lt: float = Sentinel,
         le: float = Sentinel,
         strict: bool = Sentinel,
-        deprecated: bool = Sentinel,
+        coerce_numbers_to_str: bool = Sentinel,
         multiple_of: float = Sentinel,
         allow_inf_nan: bool = Sentinel,
         max_digits: int = Sentinel,
         decimal_places: int = Sentinel,
         min_length: int = Sentinel,
         max_length: int = Sentinel,
+        union_mode: Literal["smart", "left_to_right"] = Sentinel,
         allow_mutation: bool = Sentinel,
         pattern: str = Sentinel,
         discriminator: str = Sentinel,
-        repr: bool = Sentinel,
-        fail_fast: bool = Sentinel,
     ) -> FieldHadInstruction:
         return FieldHadInstruction(
             schema=self.schema,
@@ -145,28 +182,40 @@ class AlterFieldInstructionFactory:
             field_changes=FieldChanges(
                 default=default,
                 default_factory=default_factory,
+                alias_priority=alias_priority,
                 alias=alias,
+                validation_alias=validation_alias,
+                serialization_alias=serialization_alias,
                 title=title,
+                field_title_generator=field_title_generator,
                 description=description,
+                examples=examples,
                 exclude=exclude,
                 const=const,
+                deprecated=deprecated,
+                frozen=frozen,
+                validate_default=validate_default,
+                repr=repr,
+                init=init,
+                init_var=init_var,
+                kw_only=kw_only,
+                fail_fast=fail_fast,
                 gt=gt,
                 ge=ge,
                 lt=lt,
                 le=le,
-                deprecated=deprecated,
                 strict=strict,
+                coerce_numbers_to_str=coerce_numbers_to_str,
                 multiple_of=multiple_of,
                 allow_inf_nan=allow_inf_nan,
                 max_digits=max_digits,
                 decimal_places=decimal_places,
                 min_length=min_length,
                 max_length=max_length,
+                union_mode=union_mode,
                 allow_mutation=allow_mutation,
                 pattern=pattern,
                 discriminator=discriminator,
-                repr=repr,
-                fail_fast=fail_fast,
             ),
         )
 

{cadwyn-4.4.5 → cadwyn-4.6.0}/docs/how_to/change_openapi_schemas/change_field_type.md

@@ -58,7 +58,6 @@ Additional resources:
 * <https://github.com/OAI/OpenAPI-Specification/issues/1552>
 * <https://users.rust-lang.org/t/solved-is-adding-an-enum-variant-a-breaking-change/26721/5>
 * <https://github.com/graphql/graphql-js/issues/968>
-* <https://medium.com/@jakob.fiegerl/java-jackson-enum-de-serialization-with-rest-backward-compatibility-9c3ec85ac13d>
 
 In these sections, we'll be working with our user's response model: `users.UserResource`. Note that the main theme here is "Will I be able to serialize this change to any of my versions?" as any change to responses can make them incompatible with the data in your database.
 

cadwyn-4.6.0/docs/how_to/change_openapi_schemas/change_schema_without_endpoint.md

@@ -0,0 +1,17 @@
+# Change a schema that is not used in any endpoint
+
+In some situations, we may want to use versioning not just for our openapi schemas and endpoints but also within our code such as when we want to send versioned webhooks to our clients.
+
+For example, let's say we want to change the type of an "id" field from integer to string:
+
+```python
+{!> ../docs_src/how_to/change_openapi_schemas/change_schema_without_endpoint/block001.py !}
+```
+
+Unless there is an endpoint that has `User` as its response_model, this code will end up causing an error when we run our Cadwyn app. This is because Cadwyn tries to make sure that all of your converters apply to at least one endpoint. Otherwise, it would be too easy for you to make a mistake when writing converters for the wrong schemas.
+
+To avoid it, set `check_usage=False`:
+
+```python hl_lines="21"
+{!> ../docs_src/how_to/change_openapi_schemas/change_schema_without_endpoint/block002.py !}
+```

cadwyn-4.6.0/docs_src/how_to/change_openapi_schemas/change_schema_without_endpoint/block001.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel
+
+from cadwyn import ResponseInfo, VersionChange, convert_response_to_previous_version_for, schema
+
+
+# User from latest version
+class User(BaseModel):
+    id: str
+
+
+class ChangeUserIDToString(VersionChange):
+    description = (
+        "Change users' ID field to a string to support any kind of ID. "
+        "Be careful: if you use a non-integer ID in a new version and "
+        "try to get it from the old version, the ID will be zero in response"
+    )
+    instructions_to_migrate_to_previous_version = [
+        schema(User).field("id").had(type=int),
+    ]
+
+    @convert_response_to_previous_version_for(User)
+    def change_id_to_int(response: ResponseInfo): ...