Yecine Megdiche
380ac8e79d
Remove old-style super calls ( #8226 )
2021-12-06 15:32:33 +00:00
Denis Orehovsky
8812394ed8
Add distinction between request and response serializers for OpenAPI ( #7424 )
...
* Add distinction between request and response serializers
* Add docs
* document new functions in schemas.md
* add a test case for different request vs response objects
* Correct formatting for flake8
Co-authored-by: Shaun Gosse <shaun.gosse@emburse.com>
2021-04-20 15:03:16 +01:00
Aarni Koskela
0bdd537cc4
Ignore derivations of BrowsableAPIRenderer in OpenAPI schema ( #7497 )
...
* Ignore derivations of BrowsableAPIRenderer in OpenAPI schema
* Improve test_renderer_mapping test
Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2020-10-12 16:40:26 +02:00
Justin Duke
48c327c681
Fix schema typo ( #7491 )
2020-08-24 03:44:34 -07:00
Dhaval Mehta
5ce237e004
Corrected regex serialization for OpenAPI. ( #7389 )
...
* replace \Z by \z in regex
* fix test cases for Django >= 3.0
* fix isort
* Added comment for why `\z`.
Co-authored-by: Carlton Gibson <carlton@noumenal.es>
2020-06-28 14:28:59 +02:00
Jair Henrique
bb795674f8
Drop all compat support to Django < 2 urls ( #7337 )
2020-05-14 20:31:38 +02:00
johnthagen
fccfdd21c0
Remove object inheritance in docs ( #7332 )
2020-05-13 17:54:46 -07:00
Carlton Gibson
b2497fc245
Convert openapi.AutoSchema methods to public API.
2020-04-09 20:05:16 +02:00
Carlton Gibson
b1bfff4f1c
Revert "Schemas: Improved decimal handling when mapping ChoiceField. ( #7264 )"
...
This reverts commit 1872bde462
2020-04-09 19:35:46 +02:00
Dhaval Mehta
1872bde462
Schemas: Improved decimal handling when mapping ChoiceField. ( #7264 )
2020-04-09 19:18:00 +02:00
Clinton Blackburn
603aac7db1
Corrected OpenAPI schema type for DecimalField ( #7254 )
2020-04-09 19:16:17 +02:00
Dhaval Mehta
41f27c3b43
Schemas: Don't generate component for DELETE method. ( #7229 )
2020-04-09 19:10:50 +02:00
Martin Desrumaux
6a23fa0649
OpenAPI: Make operationId camelCase, matching spec examples. ( #7208 )
2020-03-03 17:51:51 +01:00
Martin Desrumaux
8aa8be7653
Implement OpenAPI Components ( #7124 )
2020-03-02 19:35:27 +01:00
Martin Desrumaux
797518af6d
OpenAPI: Warn user about duplicate operationIds. ( #7207 )
2020-03-02 16:44:06 +01:00
Martin Desrumaux
5b16a17242
OpenAPI: Allow customizing operation name. ( #7190 )
2020-03-02 16:40:18 +01:00
Mateusz Legięcki
94a09149b6
OpenAPI: Use 201 status code for POST requests. ( #7206 )
2020-03-02 16:32:26 +01:00
Dhaval Mehta
2a5c2f3f70
Added OpenAPI tags to schemas. ( #7184 )
2020-02-28 12:06:03 +01:00
Kentalot
79d37bce4c
OpenAPI: Include type key in schema object properties dict. ( #7169 )
2020-01-30 12:14:17 +01:00
Dhaval Mehta
bc4d52558b
Schemas: Add mapping of type for ChoiceField. ( #7161 )
2020-01-29 19:15:56 +01:00
Stella
160f912a60
Schemas: Handle default=false for boolean fields ( #7165 )
2020-01-29 10:20:51 +01:00
Fábio Domingues
d22daf4e05
OpenAPI: Use _get_serializer() in _get_operation_id() ( #7160 )
2020-01-26 19:13:08 +01:00
Fábio Domingues
e4a26ad58a
Corrected _get_serializer() argument order. ( #7156 )
2020-01-23 15:53:47 +01:00
Kevin Brown
98c8af5291
ListField mapping should map all options for the child
...
Previously it was only mapping the `type` and `format`, even though
for some field types (like a `MultipleChoiceField`) we map more
than just these. And for some fields (like a `ChoiceField`) we do
not map the `type` at all.
2020-01-21 20:45:07 +01:00
Carlton Gibson
496947be3a
Inline unnecessary method in OpenAPI schema generator.
2020-01-21 20:05:13 +01:00
Carlton Gibson
d0b9577605
Return valid OpenAPI schema even when empty.
2020-01-21 20:05:13 +01:00
Tom Christie
430a567258
Update openapi.py
2020-01-03 13:50:26 +00:00
Noam
ced37a56cb
Avoid outputting callable defaults to schema. ( #7105 )
2020-01-03 13:49:46 +00:00
Ryan P Kilby
95d4843abe
Fix Django 3.0 deprecations ( #7074 )
2019-12-04 14:14:43 -08:00
Yann Savary
0d3d548aa5
OpenAPI: Fixed generation when title or version not provided. ( #6912 )
2019-11-06 21:54:12 +01:00
Yann Savary
7c3477dcda
OpenAPI: Ported docstring operation description from CoreAPI inspector. ( #6898 )
2019-11-06 21:52:02 +01:00
Kentalot
becb962160
OpenAPI: Use int64 format for large integers. ( #7018 )
2019-11-06 21:46:19 +01:00
Dima Knivets
8b06ce72d7
OpenAPI: Map renderers/parsers for request/response media-types. ( #6865 )
2019-11-06 21:44:51 +01:00
Erwan Rouchet
39bd6cc5cb
Set the proper JSON schema type for HStoreFields in OpenAPI schemas ( #6914 )
2019-10-27 21:13:01 -04:00
Jeremy Lainé
c9f06bf73f
Fix a spelling error in openapi AutoSchema method ( #7004 )
...
Replace "pagninator" by "paginator".
2019-10-24 10:51:16 +02:00
Ryan P Kilby
a8c86be660
Update linter requirements ( #7010 )
2019-10-22 11:18:51 -07:00
Guilherme Munarolo
0fd72f17ee
Fixed crash deleting required schema parameter key on PATCH requests. ( #6944 )
...
Closes #6941
2019-10-10 08:50:20 +02:00
Tom Christie
4b30b32014
Default OpenAPI version to the empty string ( #6907 )
2019-09-04 12:53:50 +01:00
Yann Savary
e57c1505fc
Replaced 'TODO' hardcoded version info by a parameter with default '0.1.0' ( #6899 )
2019-09-03 16:07:30 +02:00
Peter J. Farrell
b3f032fb8f
Fixed #6875 -- Made OpenAPI Schema operationId casing consistent. ( #6876 )
2019-09-03 16:05:43 +02:00
Dima Knivets
1cc4be47b4
Fixed min/max attributes for serializers.ListField ( #6866 )
2019-09-03 15:43:54 +02:00
Reupen Shah
f8c16441fa
Add support for pagination in OpenAPI response schemas ( #6867 )
...
Refs #6846
This provides a way for pagination classes to add pagination properties (`count`, `next`, `results` etc.) to OpenAPI response schemas.
A new method `get_paginated_response_schema()` has been added to `BasePagination`. This method is intended to mirror `get_paginated_response()` (which takes a `list` and wraps it in a `dict`).
Hence, `get_paginated_response_schema()` takes an unpaginated response schema (of type `array`) and wraps that with a schema object of type `object` containing the relevant properties that the pagination class adds to responses.
The default implementation of `BasePagination.get_paginated_response_schema()` simply passes the schema through unmodified, for backwards compatibility.
2019-09-03 15:25:44 +02:00
Dima Knivets
a142467586
Fixed incorrect OpenAPI response schema generation for a DELETE method in generic views ( #6860 )
2019-08-09 15:02:41 +02:00
Chris Vigelius
f7dc6b5656
OpenAPI: Added required description to responses. ( #6850 )
2019-08-07 22:09:27 +02:00
Chris Vigelius
0ebfbfdf81
OpenAPI: only include non-empty required property. ( #6851 )
...
Closes #6834
2019-08-07 21:40:21 +02:00
Gregory N. Schmit
335054a5d3
replace force_text with force_str
2019-08-07 21:05:24 +02:00
Reupen Shah
b45ff07294
Use an array type for list view response schemas
...
This is the first part of #6846 .
Previously, the response schema for list views was an object representing a single item. However, list views return a list of items, and hence it should be an array.
Further work will need to be done to support how pagination classes modify list responses.
There should be no change for views not determined to be list views.
2019-08-07 20:40:22 +02:00
Reupen Shah
a3f244d85e
Move AutoSchema serializer instantiation to common method
2019-08-07 20:40:22 +02:00
Chris Vigelius
ca727872c8
OpenAPI schemas: Ensure lazy field descriptions are converted to str(). ( #6832 )
2019-07-25 15:30:20 +02:00
Carlton Gibson
de26af4295
Move determine_path_prefix() logic into CoreAPI module.
2019-07-24 11:13:30 +02:00
