Changelog
#########

**3.0.0**
*********

Backwards compatibility changes
===============================
* Removed support pydantic v1 by `@NatalyaGrigoreva`_
* Minimal fastapi version up to fastapi>=0.112.3 by `@NatalyaGrigoreva`_
* Updated minimal pydantic version pydantic>=2.6.0 by `@NatalyaGrigoreva`_
* Added required dependency orjson>=3.10.0 by `@NatalyaGrigoreva`_
* Updated framework api by `@NatalyaGrigoreva`_, `@CosmoV`_

Features
========
* Added support of pydantic v2 by `@NatalyaGrigoreva`_
* Improved sqla orm query building by `@NatalyaGrigoreva`_
* Updated logic of creation custom sql filters by `@mahenzon`_
* Several bugfixes by `@NatalyaGrigoreva`_

Performance improvements
========================

* Updated ViewBase logic of response building by `@CosmoV`_
* Added storages for application lifetime entities by `@CosmoV`_
* Updated "fields" feature logic by `@CosmoV`_

Authors
"""""""

* `@CosmoV`_
* `@NatalyaGrigoreva`_
* `@mahenzon`_


**2.8.0**
*********

Performance improvements
========================

* added simple cache to SchemaBuilder by `@CosmoV`_ in `#87 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/87>`_

Authors
"""""""

* `@CosmoV`_


**2.7.0**
*********

Refactoring and relationships update fixes
==========================================

* Feature/customizable request attributes by `@CosmoV`_ in `#80 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/80>`_
* Fix cascade changes by `@CosmoV`_ in `#81 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/81>`_
* Fix update relationship by `@CosmoV`_ in `#82 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/82>`_
* SQLAlchemy Data Layer refactor by `@CosmoV`_ in `#83 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/83>`_

Authors
"""""""

* `@CosmoV`_


**2.6.0**
*********

Fix JOINS by relationships
==========================

* Fix JOINS by relationships `@CosmoV`_ in `#78 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/78>`_

Authors
"""""""

* `@CosmoV`_


**2.5.1**
*********

Fix custom sql filtering, bring back backward compatibility
===========================================================

* Fix custom sql filtering support: bring back backward compatibility by `@mahenzon`_ in `#74 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/74>`_
* Read version from file by `@mahenzon`_ in `#74 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/74>`_

Authors
"""""""

* `@mahenzon`_


**2.5.0**
*********

Fix relationships filtering, refactor alchemy helpers
=====================================================

* Fix filter by relationships by `@CosmoV`_ in `#52 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/52>`_
* Add Codecov by `@mahenzon`_ in `#72 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/72>`_
* Set ApplicationBuilder class on AtomicViewHandler by `@mahenzon`_ in `#7b2557f <https://github.com/mts-ai/FastAPI-JSONAPI/commit/7b2557f9e341c1210200efce0f7b47c15d4cac4e>`_

Authors
"""""""

* `@CosmoV`_
* `@mahenzon`_


**2.4.2**
*********

Separate helper methods for relationships query
===============================================

* fix run validator: sometimes it requires model field by `@mahenzon`_ in `#70 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/70>`_

Authors
"""""""

* `@mahenzon`_


**2.4.1**
*********

Separate helper methods for relationships query
===============================================

* remove resource manager example since no resource manager exists by `@mahenzon`_ in `#66 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/66>`_
* create separate methods for building query for fetching related objects by `@mahenzon`_ in `#67 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/67>`_
* update ruff linter by `@mahenzon`_ in `#69 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/69>`_

Authors
"""""""

* `@mahenzon`_


**2.4.0**
*********

Relationship loading, filtering improvements, fixes
===================================================

* pass request to data layer by `@mahenzon`_ in `#61 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/61>`_
* fix loading multi relationships by `@mahenzon`_ in `#59 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/59>`_
* Fix type cast in filters by `@CosmoV`_ in `#62 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/62>`_
* Fix null value filtering by `@CosmoV`_ in `#60 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/60>`_
* add py.typed by `@mahenzon`_ in `#64 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/64>`_
* limit view methods by `@mahenzon`_ in `#63 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/63>`_ - (see :ref:`api example doc <api_limited_methods_example>`)

Authors
"""""""

* `@CosmoV`_
* `@mahenzon`_


**2.3.2**
*********

Duplicated entities in response fix
===================================

* fix duplicates in list response `#48 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/48>`_

Authors
"""""""

* `@CosmoV`_
* `@mahenzon`_


**2.3.1**
*********

Pydantic validators inheritance fix
====================================

* fix schema validators passthrough `#45 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/45>`_
* fix doc build

Authors
"""""""

* `@CosmoV`_
* `@mahenzon`_


**2.3.0**
*********

Current Atomic Operation context var
====================================

* create context var for current atomic operation `#46 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/46>`_
* create example and coverage for universal dependency both for generic views and atomic operations
* tests refactoring

Authors
"""""""

* `@mahenzon`_


**2.2.2**
*********

Atomic Operation dependency resolution fixes
============================================

* fixed Atomic Operation dependency resolution `#43 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/43>`_

Authors
"""""""

* `@mahenzon`_


**2.2.1**
*********

OpenAPI generation fixes
========================

* fixed openapi generation for custom id type `#40 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/40>`_

Authors
"""""""

* `@CosmoV`_


**2.2.0**
*********

Support for pydantic validators
===============================

* Pydantic validators are applied to generated schemas now

Authors
"""""""

* `@CosmoV`_


**2.1.0**
*********

Atomic Operations
=================

* Atomic Operations (see :ref:`example <atomic_operations>`, `JSON:API doc <https://jsonapi.org/ext/atomic/>`_)
* Create view now accepts ``BaseJSONAPIItemInSchema`` as update view does

Authors
"""""""

* `@mahenzon`_


**2.0.0**
*********

Generic views, process relationships
====================================

.. note::
    Backward-incompatible changes

* Automatically create all CRUD views based on schemas (see :ref:`example <minimal_api_example>`)
* Allow to pass Client-Generated IDs (see :ref:`example <client_generated_id>`, `JSON:API doc <https://jsonapi.org/format/#crud-creating-client-ids>`_)
* Process relationships on create / update (see :ref:`example <relationships>`, `JSON:API doc <https://jsonapi.org/format/#crud-updating-resource-relationships>`_)
* Accept pydantic model with any dependencies on it (see :ref:`example <view_dependencies>`)
* handle exceptions (return errors, `JSON:API doc <https://jsonapi.org/format/#errors>`_)
* refactor data layers
* tests coverage

Authors
"""""""

* `@mahenzon`_
* `@CosmoV`_
* `@tpynio`_


**1.1.0**
*********

Generic views
=============

* Create generic view classes `#28 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/28>`_

`@CosmoV`_


**1.0.0**
*********

Backward-incompatible changes, improvements, bug fixes
======================================================

* Includes (see :ref:`example with many-to-many <include_many_to_many>`) - any level of includes is now supported (tested with 4);
* View Classes generics (Detail View and List View);
* View Classes now use instance-level methods (breaking change, previously ``classmethods`` were used);
* Pydantic schemas now have to be inherited from custom BaseModel methods (breaking change, previously all schemas were supported). It uses custom `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;
* Improved interactive docs, request and response examples now have more info, more schemas appear in docs;
* Reworked schemas resolving and building;
* Fixed filtering (schemas resolving fix);
* Create custom sql filters :ref:`example <custom_sql_filtering>`;
* Add linters: black, ruff;
* Add pre-commit;
* Add autotests with pytest;
* Add poetry, configure dependencies groups;
* Add GitHub Action with linting and testing;
* Upgrade examples;
* Update docs.

`@mahenzon`_


**0.2.1**
*********

Enhancements and bug fixes
==========================

* Fix setup.py for docs in PYPI - `@znbiz`_


**0.2.0**
*********

Enhancements and bug fixes
==========================

* Rename `from fastapi_rest_jsonapi import...` to `from fastapi_jsonapi import ...` - `@znbiz`_
* Add documentation - `@znbiz`_


.. _`@znbiz`: https://github.com/znbiz
.. _`@mahenzon`: https://github.com/mahenzon
.. _`@CosmoV`: https://github.com/CosmoV
.. _`@tpynio`: https://github.com/tpynio
.. _`@NatalyaGrigoreva`: https://github.com/NatalyaGrigoreva