encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-09-21 03:19:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,654 Commits 18 Branches 132 Tags 120 MiB
34953774f3
Commit Graph

1364 Commits

Author SHA1 Message Date
Özgür
34953774f3
docs: fix code example (#8880) 2023-02-16 12:48:34 +06:00
Manish Kumar Shah
0618fa88e1
Fix Respect can_read_model permission in DjangoModelPermissions (#8009) 
* Fix Respect `can_read_model` permission in DjangoModelPermissions

FIXES: #6324

* Updated documentation and simplified code
 2023-01-13 14:52:54 +06:00
Devid
2d19f233ab
Add SimplePathRouter (#6789) 
* Allow usage of Django 2.x path in SimpleRouter

* Use path in Default router

* Update docs/api-guide/routers.md

Co-authored-by: Éric <merwok@netwok.org>

* Update docs/api-guide/routers.md

Co-authored-by: Éric <merwok@netwok.org>

* Add tests also for default router with path

* Use a more relevant attribute for lookup when using path converters

Co-authored-by: Asif Saif Uddin <auvipy@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
 2023-01-12 14:16:48 +06:00
totycro
bfce663a60
Update documentation regarding arguments of ValidationError (#8807) 
The documentation used to state that the `detail` argument was
mandatory, but in fact it currently is not.
 2023-01-10 00:53:49 +06:00
johnthagen
069c701ebf
Update docs to maintained djangorestframework-guardian2 (#8817) 
* Update docs to maintained django-rest-framework-guardian2

* Update to updated GitHub project name
 2023-01-03 19:18:05 +06:00
Asif Saif Uddin
b3d2753308
Revert "Fix bug in validators documentation (#8779)" (#8811) 
This reverts commit 614bd87b60.
 2023-01-03 17:59:36 +06:00
Floris Hoogenboom
614bd87b60
Fix bug in validators documentation (#8779) 
Function validators seem to have to return their value (which will become part of `validated_data`) as part of their signature.
 2022-12-01 22:13:14 +06:00
T. Franzel
f0095b4de2
Remove Core API mentions from docs (#8780) 
* remove coreapi generator mentions & hidden docs

* remove coreapi doc & redirect broken links to github snapshot
 2022-11-28 14:41:08 +01:00
T. Franzel
b87699c034
Update schema generation doc & add deprecation notice #8453 (#8773) 
* Update schema generation doc & add deprecation notice #8453

* Update docs/topics/documenting-your-api.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

* Update docs/topics/documenting-your-api.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

* Update docs/topics/documenting-your-api.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

Co-authored-by: T. Franzel <13507857+tfranzel@users.noreply.github.com>
Co-authored-by: Asif Saif Uddin <auvipy@gmail.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
 2022-11-22 19:53:54 +06:00
Manos
df60510db5
Add 3rd party entry for rest-framework-roles (#8755) 2022-11-17 14:13:18 +00:00
Ilaletdinov Almaz
3e052376ac
Added http 102, 103, 421, and 425 status codes in documentation (#8763) 2022-11-17 13:13:09 +00:00
Henrik Wahlgren
d5f228dd00
Possibility to remove trailing zeros on DecimalFields representation (#6514) 
* Added normalize parameter to DecimalField to be able to strip trailing zeros. Fixes #6151.

* Updated docs to include normalize option on DecimalField

* Fixed linting error in test_fields

* Removed comment and renamed normalize to normalize_output as suggested in code review

Co-authored-by: Tom Christie <tom@tomchristie.com>
 2022-11-16 14:31:50 +00:00
Lewis M. Kabui
ae7a2b0dfa
Remove extraneous word "Both" (#8740) 
* Remove extraneous word "Both"

* Update Multiparser docs

Co-authored-by: Lewis Kabui <lewisemm@users.noreply.github.com>
 2022-11-10 10:31:06 +00:00
Francisco Couzo
041b88f8bb
Improve style, fix some typos (#8405) 
* Improve style, fix some typos

* Update docs/api-guide/fields.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

Co-authored-by: Tom Christie <tom@tomchristie.com>
 2022-10-19 11:20:11 +01:00
mka142
b221aa2cf6
Update schemas.md (#8707) 2022-10-17 09:54:48 +01:00
Shyamkumar Yadav
1fd268ae2b
Docs: use asterisk for unordered list (#8697) 2022-10-14 11:22:19 +01:00
Shyamkumar Yadav
20d347a806
Docs: Convert all tabs into spaces (#8692) 2022-10-12 11:23:45 +01:00
Aaron Taajik
058424c16a
docs: delete duplicate explanation (#8641) 2022-09-22 10:50:23 +01:00
Tim Schilling
b658915846
Version 3.14.0 proposal (#8599) 
* Version 3.14.0

* Update docs/community/release-notes.md to use proper links.

Co-authored-by: Adam Johnson <me@adamj.eu>

* Add community announcement page for version 3.14

* Remove deprecated NullBooleanField.

* Change openapi _get_reference removal to 3.15

This deprecation was never released in the 3.13.x series and therefore
can't be removed at the same time the replacement is released.

* Removing deprecated openapi methods.

Co-authored-by: Adam Johnson <me@adamj.eu>
 2022-09-21 14:08:12 +01:00
Aaron Taajik
acf6582de4
Docs: edit headings in Authentication (#8644) 2022-09-09 15:27:15 +01:00
Aaron Taajik
5b616c503f
docs: fix level of some headings (#8636) 2022-09-05 13:02:12 +01:00
Aaron Taajik
1ca1583513
docs: add the missing module name (#8635) 2022-09-05 11:20:23 +01:00
Daian Gan
c7acdd6006
Use .get() to find correct kwargs field and avoid KeyError (#8607) 
In the "Creating custom mixins" documentation, the code example recommends using
```python
if self.kwargs[field]
```
However, if the correct field is not present in kwargs, a KeyError arises.
A more secure option is tu use .get() to validate that the field is contained in the kwargs dictionary:
```python
if self.kwargs.get(field)
```
 2022-08-31 10:18:17 +01:00
Aaron Taajik
72e66e4d67
fix minor typo (#8626) 2022-08-30 12:27:48 +01:00
WillowP
dca4d7c027
Docs: Clarify model used in DjangoModelPermissions (#8615) 
I found it unclear how the model was determined for `DjangoModelPermissions`. The docs say you need a `queryset` or `get_queryset`, but not that the value returned from those is what determines the model that is used.
 2022-08-22 12:32:54 +01:00
Burak Kadir Er
2506d0b4f2
Update include and namespace URLs (#8520) 2022-06-09 15:30:47 +01:00
Alan Crosswell
563a20a040
make get_reference public (#7515) 2022-06-06 13:44:02 +01:00
Daniel Gilge
bb7dcef19b
Update get_schema in docs (#7402) 2022-06-06 13:31:00 +01:00
ghazi-git
292ead1fe0
add drf-standardized-errors to third party packages (#8487) 
Co-authored-by: Tom Christie <tom@tomchristie.com>
 2022-06-06 12:46:11 +01:00
Tom Christie
33b86a8e53
Recommend Django REST Knox (#8490) 
* Recommend Django REST Knox

* Pin jinja2 to fix docs builds
 2022-05-18 13:10:38 +01:00
Q_back
cdc956a96c
Update description of docs/api-guide/fields.md -> required (#8476) 
fix: Documentation did not point out that default value of `required`
`Field` parameter is `False` depending on the Django's `Model.field`.
 2022-05-03 11:10:37 +01:00
Aarni Koskela
b1004a4733
docs: Add a note on concurrency and races (#6950) 
Refs #5181

Co-authored-by: Adam Johnson <me@adamj.eu>
 2022-04-24 23:16:18 +01:00
Kojo Idrissa
86673a337a
corrected grammar to improve clarity (#8466) 2022-04-14 21:00:38 +01:00
Wagner de Lima
7e4e6d2070
docs: include drf-social-oauth2 to docs. (#8310) 
django-rest-framework-social-oauth2 is not a maintained library anymore.
 2022-03-23 12:09:05 +00:00
Shivendra Pratap Kushwaha
4464ce7270
Link added for Test Case Classes and corrected stable link for Refresh from DB (#8381) 
Link added for Test Case Classes and corrected stable link for Refresh from DB.
 2022-03-23 12:07:44 +00:00
Tom Christie
75f1998123
Update throttling docs (#8424) 2022-03-23 11:52:26 +00:00
Tom Christie
0e3bc2b1e0
Throttling disclaimer (#8403) 
* Throttling disclaimer

* Expand throttling disclaimer.
 2022-03-11 10:58:59 +00:00
Timothy Allen
a53e523f93
We've renamed the drf-renderer-xlsx package to drf-excel. (#8396) 2022-03-08 10:39:16 +00:00
Josh
efc7c1d664
Update accepted_media_type argument in Renderer docs (#8364) 2022-02-12 16:21:59 +00:00
Shivendra Pratap Kushwaha
94eb804abe
Update filtering.md (#8331) 2022-01-17 09:41:23 +00:00
kaushik kothiya
5b2abbed25
Correct variable name (#8306) 
urlpatterns name variable name in space remove.
 2021-12-22 15:17:57 +00:00
Guilouf
45082b3936
Fixed missing "fields" meta argument in docs (#8243) 
* Fixed missing "fields" meta argument in docs, leading to an assertion error

* Update docs/api-guide/serializers.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

Co-authored-by: Tom Christie <tom@tomchristie.com>
 2021-12-17 15:20:14 +00:00
Abhineet
f3bb5b9cdc
Add missing commas in pagination response samples (#8185) 2021-12-13 14:04:04 +00:00
Matthew Pull
3a762d9aac
Update permissions.md (#8260) 
I might just be misunderstanding something (always a strong possibility!), but it seems to me that the table on the Permissions page is slightly inaccurate.

For `permission_classes`, wouldn't it have global-level permissions for list actions (rather than no permission control, as is currently listed)?
 2021-12-08 14:35:06 +00:00
Jeremy Langley
37b73ef46e
IsAdmin permissions changed to IsAdminUser (#8227) 
Documentation change to keep up with the code permission changes.

Co-authored-by: Jeremy Langley <jlangley2code@gmail.com>
 2021-12-08 14:33:41 +00:00
Yecine Megdiche
380ac8e79d
Remove old-style super calls (#8226) 2021-12-06 15:32:33 +00:00
Anton Burnashev
060a3b632f
Docs: fix broken link (#8245) 2021-11-10 16:31:15 +00:00
Sébastien Lavoie
781890b7df
docs(api-guide-testing): Fix typo 'CRSF' and plural of word (#8238) 2021-11-08 09:59:32 +00:00
Uzair Ali
ddc5cd7e4b
Imported Response (#8207) 2021-10-07 15:52:44 +01:00
Edmund
53a0585dac
Update permissions.md to fix garden path sentences (#8206) 2021-10-07 09:09:00 +01:00