From 5e853f78a5e97541a4f96cdf900dc50ac8d76e61 Mon Sep 17 00:00:00 2001 From: Samuel Colvin Date: Fri, 26 Feb 2021 14:47:49 +0000 Subject: [PATCH] change description for #2415 --- HISTORY.md | 8 ++++++++ docs/usage/model_config.md | 2 +- docs/usage/models.md | 4 ++-- docs/usage/types.md | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 6c77d42715..975d5f1576 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -15,6 +15,14 @@ for their kind support. ### Changes +* **Breaking Change:**, remove old deprecation aliases from v1, #2415 by @samuelcolvin: + * notes on migrating to v1 + * `Schema` which was replaced by `Field` + * `Config.case_insensitive` which was replaced by `Config. case_sensitive` (default `False`) + * `Config.allow_population_by_alias` which was replaced by `Config.allow_population_by_field_name` + * `model.fields` which was replaced by `model.__fields__` + * `model.to_string()` which was replaced by `str(model)` + * `model.__values__` which was replaced by `model.__dict__` * **Breaking Change:** always validate only first sublevel items with `each_item`. There were indeed some edge cases with some compound types where the validated items were the last sublevel ones, #1933 by @PrettyWood * Update docs extensions to fix local syntax highlighting, #2400 by @daviskirk diff --git a/docs/usage/model_config.md b/docs/usage/model_config.md index 70a7545a73..e10529cc21 100644 --- a/docs/usage/model_config.md +++ b/docs/usage/model_config.md @@ -81,7 +81,7 @@ Options: not be included in the model schemas. **Note**: this means that attributes on the model with *defaults of this type*, not *annotations of this type*, will be left alone. **`schema_extra`** -: a `dict` used to extend/update the generated JSON Schema, or a callable to post-process it; see [Schema customization](schema.md#schema-customization) +: a `dict` used to extend/update the generated JSON Schema, or a callable to post-process it; see [schema customization](schema.md#schema-customization) **`json_loads`** : a custom function for decoding JSON; see [custom JSON (de)serialisation](exporting_models.md#custom-json-deserialisation) diff --git a/docs/usage/models.md b/docs/usage/models.md index 4346cbc5f5..f7aa5a2110 100644 --- a/docs/usage/models.md +++ b/docs/usage/models.md @@ -87,10 +87,10 @@ Models possess the following methods and attributes: : loads data into a model from an arbitrary class; cf. [ORM mode](#orm-mode-aka-arbitrary-class-instances) `schema()` -: returns a dictionary representing the model as JSON Schema; cf. [Schema](schema.md) +: returns a dictionary representing the model as JSON Schema; cf. [schema](schema.md) `schema_json()` -: returns a JSON string representation of `schema()`; cf. [Schema](schema.md) +: returns a JSON string representation of `schema()`; cf. [schema](schema.md) `construct()` : a class method for creating models without running validation; diff --git a/docs/usage/types.md b/docs/usage/types.md index 929188fffd..2cfa6b0ad0 100644 --- a/docs/usage/types.md +++ b/docs/usage/types.md @@ -881,7 +881,7 @@ _(This script is complete, it should run "as is")_ Similar validation could be achieved using [`constr(regex=...)`](#constrained-types) except the value won't be formatted with a space, the schema would just include the full pattern and the returned value would be a vanilla string. -See [Schema](schema.md) for more details on how the model's schema is generated. +See [schema](schema.md) for more details on how the model's schema is generated. ### Arbitrary Types Allowed