Django-ninja

Warning: This is a pre-release of Django Ninja V1

You probably should not use this version in production

----

What's new

- **async authentication** fully supported on all layers
- **CSRF is now automatic** on Cookie based authentication ( now you should be able to combine multiple cookie/header/etc authenticators and play around with csrf logic)
- **Pydantic2** - which has a core re-written in Rust and includes a lot of improvements and features like:
- Safer types.
- Better extensibility.
- Better performance - so far on few projects that I tested getting average 10% speed improvements (some particular views which do lot of validations should get pretty good bumps)

Unfortunately Django ninja integrates very deep into pydantic core with Schema class, so it is not possible to keep both pydantic v1 and v2 supported - and that is why ninja now bumps to version 1 which might have few deprecations or breaking changes on pydantic level

From Django ninja side I'm trying to make this upgrade as smooth as possible, if you use standard APIs without lot of magic - most likely upgrade should be without any code change

- Fixed schema generation bug 774

Fixes a swagger ui error

What's Changed
* ModelSchema now support config.model_fields_optional to mark some or specific fields to be not required in schema
* Implement rudimentary support for async auth by kjagiello in https://github.com/vitalik/django-ninja/pull/735
* Allow to extend additional info key, value to OpenAPI Info section by chenatlas in https://github.com/vitalik/django-ninja/pull/715
* fix typo by quique in https://github.com/vitalik/django-ninja/pull/706
* api_operation is better described as a decorator by quique in https://github.com/vitalik/django-ninja/pull/707
* Added a section detailing how to reverse a url for the api docs page. by SunsetOrange in https://github.com/vitalik/django-ninja/pull/714
* Fix missing openapi endpoints by rednaks in https://github.com/vitalik/django-ninja/pull/731
* Add Django 4.2 support in `pyproject.toml` by baseplate-admin in https://github.com/vitalik/django-ninja/pull/736
* Added missing space by TheHippo in https://github.com/vitalik/django-ninja/pull/737
* fix: allow default example to be included in pagination output in generated API docs. by jkeyes in https://github.com/vitalik/django-ninja/pull/728
* Fix kwargs typing by SmileyChris in https://github.com/vitalik/django-ninja/pull/745
* Only title-case fields in schema if all lowercase verbose name by SmileyChris in https://github.com/vitalik/django-ninja/pull/748
* fix: paginate typo by MrEcho92 in https://github.com/vitalik/django-ninja/pull/752
* feat: add JSON encoding support for IPv4Address and IPv6Address by jkeyes in https://github.com/vitalik/django-ninja/pull/729
* Enable exception_handler to handle Pyright's strict mode by paulzakin in https://github.com/vitalik/django-ninja/pull/762
* Make optional field of UploadedFile optional by karlosss in https://github.com/vitalik/django-ninja/pull/766


New Contributors
* quique made their first contribution in https://github.com/vitalik/django-ninja/pull/706
* SunsetOrange made their first contribution in https://github.com/vitalik/django-ninja/pull/714
* rednaks made their first contribution in https://github.com/vitalik/django-ninja/pull/731
* TheHippo made their first contribution in https://github.com/vitalik/django-ninja/pull/737
* jkeyes made their first contribution in https://github.com/vitalik/django-ninja/pull/728
* MrEcho92 made their first contribution in https://github.com/vitalik/django-ninja/pull/752
* paulzakin made their first contribution in https://github.com/vitalik/django-ninja/pull/762
* karlosss made their first contribution in https://github.com/vitalik/django-ninja/pull/766
* andZibralabs made their first contribution in https://github.com/vitalik/django-ninja/pull/695
* kjagiello made their first contribution in https://github.com/vitalik/django-ninja/pull/735
* chenatlas made their first contribution in https://github.com/vitalik/django-ninja/pull/715

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v.0.21.0...v0.22.0

v.0.21.0
What's Changed
* Somewhat advanced filtering with FilterSchema by l1b3r in https://github.com/vitalik/django-ninja/pull/673
* Support both new and old style Union/Optional by gvangool in https://github.com/vitalik/django-ninja/pull/687
* Allow reversing URLs with multiple operations. by strange in https://github.com/vitalik/django-ninja/pull/638
* feat: openapi schema improvements by aliereno in https://github.com/vitalik/django-ninja/pull/504
* Fix 666: Support auth inheritance for routers by aasiffaizal in https://github.com/vitalik/django-ninja/pull/667
* improve error message in export_openapi_schema by taobojlen in https://github.com/vitalik/django-ninja/pull/653
* Add source maps for Redoc and Swagger UI by chris-mcdo in https://github.com/vitalik/django-ninja/pull/676
* Include information about Django 4.1 async ORM by geeshta in https://github.com/vitalik/django-ninja/pull/578
* Update crud.md by Trystanr in https://github.com/vitalik/django-ninja/pull/688
* Add a recipe for handling the file uploads by barseghyanartur in https://github.com/vitalik/django-ninja/pull/663
* [Docs] remove broken link by GTorreil in https://github.com/vitalik/django-ninja/pull/647
* Fix links to favicon in CDN templates by stephane in https://github.com/vitalik/django-ninja/pull/636
New Contributors
* geeshta made their first contribution in https://github.com/vitalik/django-ninja/pull/578
* GTorreil made their first contribution in https://github.com/vitalik/django-ninja/pull/647
* barseghyanartur made their first contribution in https://github.com/vitalik/django-ninja/pull/663
* aasiffaizal made their first contribution in https://github.com/vitalik/django-ninja/pull/667
* taobojlen made their first contribution in https://github.com/vitalik/django-ninja/pull/653
* l1b3r made their first contribution in https://github.com/vitalik/django-ninja/pull/673
* strange made their first contribution in https://github.com/vitalik/django-ninja/pull/638
* chris-mcdo made their first contribution in https://github.com/vitalik/django-ninja/pull/676
* Trystanr made their first contribution in https://github.com/vitalik/django-ninja/pull/688
* gvangool made their first contribution in https://github.com/vitalik/django-ninja/pull/687
* aliereno made their first contribution in https://github.com/vitalik/django-ninja/pull/504

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v0.20.0...v.0.21.0

What's Changed
* Speedup code reload by hiaselhans in https://github.com/vitalik/django-ninja/pull/624
* Added a support for openapi ServerObject by Vaiders in https://github.com/vitalik/django-ninja/pull/574
* Fix url_namespace -> urls_namespace msg by SmileyChris in https://github.com/vitalik/django-ninja/pull/519
* add --sorted flag to export_openapi_schema by hiaselhans in https://github.com/vitalik/django-ninja/pull/571
* Set correct media type in docs for custom renderer by Svenito in https://github.com/vitalik/django-ninja/pull/598
* Update swagger UI to 4.14.0 by kabell in https://github.com/vitalik/django-ninja/pull/553
*
Documentation
* Shuffle doc files around by vpoulailleau in https://github.com/vitalik/django-ninja/pull/543
* Fix README link to "async support" by denizdogan in https://github.com/vitalik/django-ninja/pull/545
* Add repository url in `pyproject.toml` by baseplate-admin in https://github.com/vitalik/django-ninja/pull/563
* Set up doc search by tssujt in https://github.com/vitalik/django-ninja/pull/572

Misc
* remove python 3.6 by hiaselhans in https://github.com/vitalik/django-ninja/pull/625
* Bump actions/checkout from 2 to 3 by dependabot in https://github.com/vitalik/django-ninja/pull/411
* Bump actions/setup-python from 2 to 4 by dependabot in https://github.com/vitalik/django-ninja/pull/493
* Fix failing `flit` build by baseplate-admin in https://github.com/vitalik/django-ninja/pull/564

New Contributors
* vpoulailleau made their first contribution in https://github.com/vitalik/django-ninja/pull/543
* denizdogan made their first contribution in https://github.com/vitalik/django-ninja/pull/545
* baseplate-admin made their first contribution in https://github.com/vitalik/django-ninja/pull/563
* hiaselhans made their first contribution in https://github.com/vitalik/django-ninja/pull/571
* Svenito made their first contribution in https://github.com/vitalik/django-ninja/pull/598
* Vaiders made their first contribution in https://github.com/vitalik/django-ninja/pull/574
* kabell made their first contribution in https://github.com/vitalik/django-ninja/pull/553

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v0.19.1...v0.20.0

What's Changed

* Declare the AuthenticationError exception class in __all__ by duducp in https://github.com/vitalik/django-ninja/pull/489
* Small fix for many2many payloads to allow passing primary keys for model fields

Documentation
* Docs restructure by SmileyChris in https://github.com/vitalik/django-ninja/pull/334
* Add documentation on the `.from_orm` method by cltrudeau in https://github.com/vitalik/django-ninja/pull/503
* Added mutiple items example by ihelmer07 in https://github.com/vitalik/django-ninja/pull/509


New Contributors
* cltrudeau made their first contribution in https://github.com/vitalik/django-ninja/pull/503
* ihelmer07 made their first contribution in https://github.com/vitalik/django-ninja/pull/509

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v.0.19.0...v0.19.1

v.0.19.0
What's Changed

* docs decorator by vitalik in https://github.com/vitalik/django-ninja/pull/488
* Allow arbitrary Pagination Output ( alternative 464 rafonseca ) by vitalik in https://github.com/vitalik/django-ninja/pull/483
* Update Redoc related documents by tssujt in https://github.com/vitalik/django-ninja/pull/462
* Improves authentication validation to throw an exception by duducp in https://github.com/vitalik/django-ninja/pull/454
* Add TestClient note to multiple APIs warning by srcreigh in https://github.com/vitalik/django-ninja/pull/416
* Implement implicit reverse url name generation by SmileyChris in https://github.com/vitalik/django-ninja/pull/361
* Also pass the router to `get_operation_url_name` by SmileyChris in https://github.com/vitalik/django-ninja/pull/486
* [feat] add superuser session authentication only by areski in https://github.com/vitalik/django-ninja/pull/351


New Contributors
* tssujt made their first contribution in https://github.com/vitalik/django-ninja/pull/462
* duducp made their first contribution in https://github.com/vitalik/django-ninja/pull/454
* srcreigh made their first contribution in https://github.com/vitalik/django-ninja/pull/416
* areski made their first contribution in https://github.com/vitalik/django-ninja/pull/351

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v.0.18.0...v.0.19.0

v.0.18.0
Hello

Please welcome the new Django Ninja version
it has lot of fixes and improvements

Most notable a HttpResponse typed argument by SmileyChris

Now you can manage response behaviour (cookies, headers, streaming) flixible:

Python
api.post("/boop")
def boop(request, response: HttpResponse): !
response.set_cookie("beep", "boop") !
return True


All changes
* Provide a temporal HttpResponse typed argument to views by SmileyChris in https://github.com/vitalik/django-ninja/pull/336
* UploadedFile inherit from Django's UploadedFile by OtherBarry in https://github.com/vitalik/django-ninja/pull/400
* Allow path parameters to be specified at router level by kaschnit in https://github.com/vitalik/django-ninja/pull/369
* Added support for postgress specific fields to Model Schema 353
* Fixed openapi/pydantic versions compatibility 418
* pre-commit config by SmileyChris in https://github.com/vitalik/django-ninja/pull/364
* Access to test response attributes by stephane in https://github.com/vitalik/django-ninja/pull/402
* Small optimization and typing improvements by SmileyChris in https://github.com/vitalik/django-ninja/pull/367
* Minor typo in tutorial by stephane in https://github.com/vitalik/django-ninja/pull/387
* Specify mypy in CONTRIBUTING.md by OtherBarry in https://github.com/vitalik/django-ninja/pull/401
* ConfigError: ModelSchema classes requires a 'Config' subclass by sebastian-philipp in https://github.com/vitalik/django-ninja/pull/382
* Fix a typing issue by HoJin9622 in https://github.com/vitalik/django-ninja/pull/404
* Fix a few typos by dy3l in https://github.com/vitalik/django-ninja/pull/426
* Add Redoc support by kxxoling in https://github.com/vitalik/django-ninja/pull/427
* Fix typo in docs by sho918 in https://github.com/vitalik/django-ninja/pull/432
* Handle class instances in `signature.details.is_collection_type` by flaeppe in https://github.com/vitalik/django-ninja/pull/434
* Upgrade versions of pre-commit hooks by flaeppe in https://github.com/vitalik/django-ninja/pull/435

New Contributors
* kaschnit made their first contribution in https://github.com/vitalik/django-ninja/pull/369
* stephane made their first contribution in https://github.com/vitalik/django-ninja/pull/387
* OtherBarry made their first contribution in https://github.com/vitalik/django-ninja/pull/400
* sebastian-philipp made their first contribution in https://github.com/vitalik/django-ninja/pull/382
* HoJin9622 made their first contribution in https://github.com/vitalik/django-ninja/pull/404
* dy3l made their first contribution in https://github.com/vitalik/django-ninja/pull/426
* kxxoling made their first contribution in https://github.com/vitalik/django-ninja/pull/427
* sho918 made their first contribution in https://github.com/vitalik/django-ninja/pull/432
* flaeppe made their first contribution in https://github.com/vitalik/django-ninja/pull/434

**Full Changelog**: https://github.com/vitalik/django-ninja/compare/v0.17.0...v0.18.0