Skip to content

Commit 93e9d02

Browse files
committed
update docs
1 parent 9f2535f commit 93e9d02

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

docs/changelog.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ Backward-incompatible changes, improvements, bug fixes
1111
* 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
15-
, previously all schemas were supported
16-
). It uses custom :ref:`registry class <https://github.com/mts-ai/FastAPI-JSONAPI/blob/188093e967bb80b7a1f0a86e754a52e47f252044/fastapi_jsonapi/schema_base.py#L33>`:
17-
, 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;
1815
* Improved docs, request and response examples have more info, more schemas appear in docs;
1916
* Reworked schemas resolving and building;
2017
* Fixed filtering (schemas resolving fix);

docs/custom_filter_example.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. _custom_sql_filtering:
22

3+
34
Custom SQL filtering
45
####################
56

@@ -39,6 +40,7 @@ Request:
3940
Filter value has to be a valid JSON:
4041

4142
.. sourcecode:: JSON
43+
4244
[
4345
{
4446
"name":"picture.meta",

docs/include_many_to_many.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _include_many_to_many:
22

3-
Include nested and related Many-to-Many
4-
#######################################
3+
Include nested and related, Many-to-Many
4+
########################################
55

66
.. currentmodule:: fastapi_jsonapi
77

@@ -114,7 +114,7 @@ Child Views
114114

115115

116116
List Parent objects with Children through an Association object
117-
---------------------------------------------------------------
117+
===============================================================
118118

119119
Request:
120120

0 commit comments

Comments
 (0)