Skip to content

Commit fd8ab15

Browse files
committed
update docs
1 parent 93e9d02 commit fd8ab15

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/changelog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Changelog
88
Backward-incompatible changes, improvements, bug fixes
99
======================================================
1010

11-
* Includes (see :ref:`example with many-to-many <include_many_to_many>`:) - any level of includes is now supported (tested with 4);
11+
* Includes (see :ref:`example with many-to-many <include_many_to_many>`) - any level of includes is now supported (tested with 4);
1212
* View Classes generics (Detail View and List View);
1313
* View Classes now use instance-level methods (breaking change, previously ``classmethods`` were used);
14-
* Pydantic schemas now have to be inherited from custom BaseModel methods (breaking change, previously all schemas were supported). It uses custom :ref:`registry class <https://github.com/mts-ai/FastAPI-JSONAPI/blob/188093e967bb80b7a1f0a86e754a52e47f252044/fastapi_jsonapi/schema_base.py#L33>`:, so we can collect and resolve all schemas. Maybe there's some workaround to collect all known schemas;
14+
* Pydantic schemas now have to be inherited from custom BaseModel methods (breaking change, previously all schemas were supported). It uses custom :ref:`registry class <https://github.com/mts-ai/FastAPI-JSONAPI/blob/188093e967bb80b7a1f0a86e754a52e47f252044/fastapi_jsonapi/schema_base.py#L33>`, so we can collect and resolve all schemas. Maybe there's some workaround to collect all known schemas;
1515
* Improved docs, request and response examples have more info, more schemas appear in docs;
1616
* Reworked schemas resolving and building;
1717
* Fixed filtering (schemas resolving fix);
1818
* Fixed filtering (schemas resolving fix);
19-
* Create custom sql filters :ref:`example <custom_sql_filtering>`:;
19+
* Create custom sql filters :ref:`example <custom_sql_filtering>`;
2020
* Add linters: black, ruff;
2121
* Add pre-commit;
2222
* Add autotests with pytest;

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ FastAPI-JSONAPI with FastAPI.
5353
minimal_api_example
5454
api_filtering_example
5555
quickstart
56-
logical_data_abstraction
57-
resource_manager
58-
data_layer
5956
routing
6057
filtering
6158
include_related_objects
6259
include_many_to_many
6360
custom_sql_filtering
61+
logical_data_abstraction
62+
resource_manager
63+
data_layer
6464
sparse_fieldsets
6565
pagination
6666
sorting

0 commit comments

Comments
 (0)