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
thetarby
6ea95b6ad1
Highlight select_related and prefetch_related usage in documentation ( #7610 )
...
* docs updated to highlight use of select_related and prefetch related to avoid n+1 problems
* Apply suggestions from code review
cosmetic changes
Co-authored-by: Xavier Ordoquy <xordoquy@linovia.com>
* cosmetic changes
Co-authored-by: Xavier Ordoquy <xordoquy@linovia.com>
2021-10-05 15:33:55 +01:00
Akhil Kokani
1fa5bc31c0
Update serializers.md ( #8189 )
...
* Update serializers.md
Removed unwanted word, "neither".
* Update docs/api-guide/serializers.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-09-27 10:01:47 +01:00
Carlton Gibson
f651878df3
Adjusted DateTimeField docs for zoneinfo.
2021-09-22 10:23:46 +02:00
Dan Lousqui
f0a5b958a1
Add max_length and min_length options to ListSerializer ( #8165 )
2021-09-14 13:45:55 +01:00
Ryan Nowakowski
4632b5daae
Fix subtitle of schemas for filtering ( #8145 )
...
Fix a likely copy/paste error
2021-08-31 14:18:49 +01:00
Aditya Mitra
6b392a46ea
[FIX] Typo in api-guide/authentication ( #8144 )
2021-08-31 13:57:02 +01:00
Mark
c5d9144aef
fix typo ( #8122 )
...
Co-authored-by: mgold <mgold@iponweb.net>
2021-08-11 11:30:09 +01:00
Ma77heus
2942590ee3
fix: broken cite ( #8086 )
...
Co-authored-by: MattheusHenrique <mattheushenrique@gmail.com>
2021-08-06 16:39:58 +01:00
Nikita Sobolev
d2977cff98
Fixes inconsistent headers in serializer docs ( #8056 )
...
Some headers were using `.`, some - were not.
Now, all of them are the same with `.`, because it was easier to fix.
2021-06-28 13:07:41 +01:00
Burak Kadir Er
c8a9c856c2
fix a small typo ( #8060 )
2021-06-28 12:51:21 +01:00
Abduaziz
9d149f2317
Fixed some punctuation marks & small typos ( #8015 )
2021-06-02 10:02:11 +01:00
Ishu Kumar
3875d3284e
Punctuations and missing "to" preposition ( #7966 )
...
Changes made in lines 221, 222, 223, and 224 for better readability.
2021-05-10 12:26:26 +01:00
Julien Palard
a0083f7f98
FIX: Broken cite. ( #7951 )
2021-04-26 09:30:41 +01: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
Joe Michelini
71e6c30034
update SerializerMethodField example in docs ( #7858 )
...
* update SerializerMethodField example
* fix formatting
2021-03-22 12:08:19 +00:00
Hasan Talha Yazıcı
0cddf097ca
Fix typo in docs ( #7853 )
2021-03-21 09:53:09 +00:00
Yuekui
a40bce50cd
No need to explictitly set None as default ( #7373 )
2021-03-16 13:29:13 +00:00
Henryk Plötz
ff625ecff5
Document object level permissions gotchas ( #7446 )
...
* Document the limitation that object level permissions do not apply to object creation. See for example #6409 .
* Add overview of three different ways to restrict access
2021-03-15 10:28:45 +00:00
Feanil Patel
c78f992176
Make the doc on overriding the default permission classes more clear. ( #7661 )
2021-03-10 12:44:17 +00:00
