encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-12-01 22:14:06 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,367 Commits 18 Branches 132 Tags 105 MiB
ef112f5017
Commit Graph

42 Commits

Author SHA1 Message Date
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
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
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
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
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
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
John Franey
f20e282d15 Update documenting-your-api.md (#5991) 
Fix link to "Schemas as Documentation: Examples"
 2018-05-17 00:36:41 -04:00
Carlton Gibson
a540acdc95
Allowed customising API documentation code samples (#5752) 
* Allowed additional languages in API documentation

* Documented renderer_classes parameter and customising languages.
 2018-01-25 09:39:03 +01:00
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Cristi Vîjdea
522d453546 Add drf-yasg to documentation and schema 3rd party packages (#5720) 
Also fixed broken `swagger` link.
 2018-01-02 14:51:54 +01:00
Jimmy Merrild Krag
ea0b3b32ad Fix typo (#5687) 
Fixed `include_docs_url` to be `include_docs_urls`
 2017-12-19 15:03:47 +01:00
Carlton Gibson
6560f44912
Update OPTIONS example from “Documenting Your API” (#5680) 
Closes #3489

* Updates example to post-3.0 API, using metadata class
* Adds link to metadata docs.
 2017-12-19 12:05:46 +01:00
Carlton Gibson
2befa6c316 Document documentation.py (#5478) 
Closes #5198. Closes #5142. Closes #4980
 2017-10-04 12:12:06 +02:00
Lim H
62ecbf2817 Add drf-openapi (#5470) 
* Add DRF OpenAPI as a 3rd party tool for DRF doc

* Add image

* Add third party packages section to schema doc

* Add DRF OpenAPI reference
 2017-10-02 11:16:33 +02:00
Vašek Dohnal
1f2e2dea96 Fixed typo in docs/Documenting your API (#5316) 2017-08-08 10:01:19 -04:00
Tom Christie
86931b01b6 Note dependancies in docs 2017-03-09 14:59:00 +00:00
Tom Christie
0b708f04e1 Client library & API documentation docs (#4939) 2017-03-06 12:42:51 +00:00
Tom Christie
68d2020112 Live API documentation (#4755) 2017-03-03 15:24:37 +00:00
Binoj David
d58c89adc1 Fix Schemas Example URL 2017-02-28 22:45:17 +05:30
nmgeek
ab0c57718a Direct readers to info on how to add viewset docs (#4844) 
I believe the original statement was wrong.  You can, in fact, document the various API endpoints of a ViewSet.
 2017-01-24 09:57:14 +00:00
Makedonsky
69366a11d7 modify documenting-your-api docs topic 2017-01-03 13:17:07 +02:00
Emmanouil Konstantinidis
ee2861887e Mention DRF Docs - Live API Endpoints 2016-01-23 23:08:19 +00:00
Emmanouil Konstantinidis
1925ec7d33 Both are highly recommended 2015-12-21 13:59:05 +00:00
Emmanouil Konstantinidis
4204557bc5 Remove title and hr 2015-12-21 13:55:11 +00:00
Emmanouil Konstantinidis
958290724c Rest is "REST" 2015-12-21 13:47:04 +00:00
Emmanouil Konstantinidis
a83cb1d2f3 Minor changes 2015-12-21 13:45:11 +00:00
Emmanouil Konstantinidis
1aedaafba4 Add DRF docs to the list 2015-12-21 13:40:23 +00:00
José Padilla
200e0b17da Clean up extra white space 2014-11-25 12:44:11 +00:00
catherinedodge
bfd0b261db Fixed small typo 2014-08-14 13:39:21 -04:00
Veronica Lynn
4d8d2340be Fixed typos in a bunch of docs 2013-08-07 14:00:06 -04:00
Tom Christie
0950d3e0ef Tweak docs 2013-07-04 08:02:08 +01:00
Tom Christie
7c0019854b Horizontal rule for nicer formatting 2013-07-03 13:19:07 +01:00
Tom Christie
03e0ce35fe Added 'Documenting your API' section. Closes #616 2013-07-02 22:15:46 +01:00