encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-29 04:54:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,623 Commits 18 Branches 132 Tags 105 MiB
9e328a9549
Commit Graph

974 Commits

Author SHA1 Message Date
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
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
Elton Maiyo
e354331743
Fixes typo (#8719) 2022-10-19 11:11:09 +01:00
mschmidm
99cf2c415f
Docs: Updated browsable-api.md (#8678) 
- Replace the broken Bootswatch-Link with an Jsdelivr-Link as suggested at https://bootswatch.com/help/
- Updated the stated Bootstrap version
- Added a note that the Bootstrap version must match the default one

Co-authored-by: Tom Christie <tom@tomchristie.com>
 2022-10-04 12:15:51 +01:00
denniskloyn
02eeb6fa00
Change MIDDLEWARE_CLASSES to MIDDLEWARE (#8333) 
The `MIDDLEWARE_CLASSES` setting got changed to `MIDDLEWARE` in [Django 1.10](https://docs.djangoproject.com/en/1.10/topics/http/middleware/).
 2022-01-18 08:52:11 +00:00
Jaap Roes
dabf2216c3
Update django-cors-headers links (#8176) 2021-12-08 14:30:34 +00:00
Romain Rigaux
750bad0a58
Actually use the loginUser arguments in the example (#7714) 2021-03-09 12:00:51 +00:00
Jean-Pierre Merx
234527959d
Have options example in documenting-your-api.md to return a Response (#7639) 
It was returning data which is not correct. Closes #7638.

Co-authored-by: Jean-Pierre Merx <jean-pierre.merx@aictivate.com>
 2021-03-08 12:08:26 +00:00
Karol Onyśko
96993d817a
Changed url to django docs so it points to the stable version (#7628) 
Co-authored-by: Karol Onyśko <karol.onysko@cic.com>
 2020-11-12 18:42:42 +01:00
Xavier Ordoquy
2e721cdbc8
Merge pull request #7436 from markstory/patch-1 
Fix broken links in documenting API section
 2020-10-06 22:26:22 +02:00
T. Franzel
c6e24521da
Add third-party schema library drf-spectacular to docs (#7540) 
Co-authored-by: T. Franzel <13507857+tfranzel@users.noreply.github.com>
 2020-09-21 11:39:35 +01:00
Adam Johnson
410575dace
Replace all url() calls with path() or re_path() (#7512) 
* url() is deprecated in Django 3.1

* update given feedbacks on url() is deprecated in Django 3.1

* Fix test_urlpatterns.py to continue testing mixed re_path() and path()

* Fix one missed reference

Co-authored-by: sanjusci <sanju.sci9@gmail.com>
 2020-09-08 15:32:27 +01:00
Vibhu Agarwal
3d708ac700
Fix broken docs link (#7473) 2020-08-11 16:36:23 -07:00
Mark Story
30ca04df83
Fix broken links in documenting API section 
The changed links were not working on the documentation site. I'm not 100% sure that these changes are correct but they generate working links in the GitHub previews.
 2020-07-29 09:58:53 -04:00
phankiewicz
a9e55334e7 Add X-CSRFToken HTTP header in swagger-ui example (#6968) 2020-01-03 13:59:32 +00:00
Jihoon Park
f3ed69374d Add missing punctuation marks and URL name (#7108) 
- trailing commas (as both Python and JavaScript allow them)
- trailing semicolons in JavaScript
- URL name `api-docs`
 2020-01-03 13:28:35 +00:00
James
323e1cddda Cleanup "Documenting your API" 3rd party recommendations (#7057) 2019-11-15 18:39:47 -08:00
Chris Guo
a734e58d44 Fix docs typos (#7006) 2019-10-21 15:11:12 -07:00
David Sanders
9850441e6f Fix docs typo (#6974) 2019-10-08 16:37:58 -07:00
Min ho Kim
0e1c5d3132 Fix typos (#6835) 2019-07-25 10:04:01 -07:00
Luke Plant
f0dbf0a264 Update docs to use lists instead of tuples (#6797) 2019-07-12 18:15:36 -07:00
Carlton Gibson
7915485c0d Update docs for OpenAPI. (#6668) 
* Update schema docs for OpenAPI

* Begin v3.10 Release Announcement.

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

Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>

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

Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>

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

Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>

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

Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
 2019-07-08 13:09:05 +01:00
Étienne Noss
f5470ab9e2 docs: update http method override middleware example (#6776) 2019-07-03 10:23:35 +01:00
Aart Goossens
0f819d844d Remove recommendation for DRF Docs (#6580) 
Since DRF Docs is not compatible with the latest version of DRF (or Django?; related issue: https://github.com/manosim/django-rest-framework-docs/issues/180) and the latest release is almost 3 years ago I suggest to remove the recommendation for this package.
 2019-05-03 15:26:06 -07:00
Jimmy Merrild Krag
14fad0d690 Fix capitalization, markdown syntax link in docs (#6621) 
The `Pygments` and `Markdown` python packages have first letter capital.
Fixed link to markdown syntax to go directly to the syntax page.
 2019-05-02 18:17:33 -07:00
Carlton Gibson
d932baa646
Corrected link to ajax-form library. 
Closes #6465.
 2019-02-22 11:11:52 +01:00
Cyrus Ghazanfar
7ad5bdb669 Adjusted login template override example (#6265) 2018-12-19 15:25:34 +01:00
Stephen Finucane
fae7e91728 docs: Remove references to drf-openapi (#6272) 
This has been EOL'd in favour of drf-yasg [1].

[1] https://github.com/limdauto/drf_openapi/commit/1673c6e0

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-03 15:57:47 +01:00
Daniel Bate
5feb835929 Feature/action docs sections (#6060) 
* added ability to add sections to custom action documentation

* added tests to cover docs sections in custom actions

* added method specific docs test for action mapping

* added docs for custom action documentation
 2018-10-10 10:29:29 +02:00
Jon Dufresne
878f9d2783 Prefer https:// for URLs when available throughout project (#6208) 2018-10-02 08:28:58 +02:00
Melissa Lewis
b090ae9d30 Fix docs typos (#6195) 2018-09-18 15:32:32 -07:00
Eze Sunday
a0277919f0 Fix grammar mistake in html-and-forms.md (#6070) 2018-07-08 16:11:05 -04:00
Ryan P Kilby
99ca078ebb Add "Community" section to docs, minor cleanup (#5993) 
* Add 'Community' tab to navigation, move articles

* Drop DRF 2.x announcements and the docs note

* Drop embedded tutorial/guide/topics links

* Conver mixture of tabs/spaces => spaces

* Fix topics/community links
 2018-07-06 11:28:18 +02:00
Ryan P Kilby
7095021db7 Rename base_name => basename for consistency's sake (#5990) 
* Rename base_name => basename for consistency

* Update tests to use basename
 2018-07-06 11:03:12 +02:00
William S. Vincent
feffa109a8 Add REST APIs with Django book (#6033) 
Just published book dedicated to DRF.
 2018-06-20 00:24:26 +01:00
Jon Dufresne
89fb0b0f99 Update incorrect PyPI URL to register an account 
To register an account on PyPI, the URL is
https://pypi.org/account/register/, which changed after the move to
pypi.org.
 2018-06-09 19:09:31 -07:00
John Franey
f20e282d15 Update documenting-your-api.md (#5991) 
Fix link to "Schemas as Documentation: Examples"
 2018-05-17 00:36:41 -04:00
Ari Rouvinen
45acfe05b4 Add missing comma (#5978) 2018-05-08 09:15:59 +01:00
Andreas Lutro
a6b6b6ce55 remove references to DOAC in docs (#5977) 
Project has been archived on github and recommends alternative.
 2018-05-08 09:10:43 +01:00
Jochen Wersdörfer
c4676510fd Adjusted client JWT example (#5944) 2018-04-20 15:33:59 +02:00
Jon Dufresne
8c47a875ec Update all pypi.python.org URLs to pypi.org (#5942) 
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
 2018-04-19 08:36:18 +02:00
Arne Schauf
d5fe1f66ac Fix a typo in the 3.8 announcement (#5940) 2018-04-18 06:36:03 +01:00
David Jean Louis
1c53fd3212 Added djangorestframework-datatables to third-party packages (#5931) 2018-04-10 13:25:20 +01:00
Anna Ossowski
0178d3063d
Added 3.8 release + updated monthly report link 2018-04-08 21:47:50 +02:00
Carlton Gibson
fb802c0910
Update version and notes for 3.8.2 release. (#5923) 2018-04-06 15:41:11 +02:00
Carlton Gibson
bc353452f4
Bump version and release notes for 3.8.1 (#5916) 2018-04-04 21:10:34 +02:00
Ryan P Kilby
cba426b34c Use old url_name behavior in route decorators (#5915) 
* Wrap action decorator for old url_name behavior
 2018-04-04 20:50:42 +02:00
Xavier Ordoquy
3a29eff5f8 release_notes: fix call to super().data 
`super().data()` leads to a `TypeError` saying that 'ReturnDict' object
is not callable.
 2018-04-04 15:21:36 +02:00
Carlton Gibson
2621e03aa3 Added 3.8 announcement to docs 
Correct release notes MD formatting
 2018-04-03 16:06:06 +02:00
Carlton Gibson
fc588f539b
Version 3.8 Release (#5769) 2018-04-03 15:35:26 +02:00