Thibaud Colas
a0eea3a85c
Add Django Ninja to API documentation
2025-05-06 13:29:15 +01:00
Thibaud Colas
9f63d7f000
Document expand_db_html usage for rich text in REST framework API. Fix #2695
2025-05-06 13:29:15 +01:00
Thibaud Colas
08c0ce9f45
Further document usage of API ?limit. Fix #12604
2025-05-06 13:29:15 +01:00
Sævar Öfjörð Magnússon
8ec4ed0127
Incorporate 'are we headless' content into documentation
...
- API chapters from https://areweheadlessyet.wagtail.org/
2024-12-04 08:10:15 +10:00
Srishti-j18
d2f476c050
Documentation - Update page titles to align with Style Guide
...
- Use sentence case for headings and titles. (as per the Google Developer Documentation Style Guide)
- Fixes #12466
2024-10-27 15:27:03 +10:00
Krzysztof Jeziorny
72292d4d01
Documentation: Configure API to use the DRF's TokenAuthentication ( #12363 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-09-29 15:59:15 +01:00
Himanshu Garg
e02ca6ce62
fixes some of errors by removing directives
2024-07-18 23:13:26 +01:00
Buraah
56335de636
Update documentation globally to use US spelling (not UK) + grammar fixes
...
- Transferred all British spellings in the usage guide and advanced topics section to American spellings
2024-01-30 07:30:57 +10:00
Rohit Sharma
996abeae8e
Add initial redirects (contrib) API endpoint
...
Builds on previous PRs #6110 & #8842
2024-01-24 10:42:25 +10:00
LB Johnston
145e33de9d
5.2 release notes - add supporting links and fix typos
2023-10-20 10:13:27 +01:00
Neeraj P Yetheendran
cdd6f1800c
Allow subclasses of PagesAPIViewSet override default Page model
...
- Built on original PR #7372 and feedback on that solution
- Add unit tests and documentation
- Fix typo in API documentation for `CustomPagesAPIViewSet`
- Ensure that pk is used (not id) while filtering to prevent assumption that id is pk
2023-09-20 08:13:19 +10:00
LB Johnston
aa9e9cddc7
Resolve multiple typos (spelling and grammar)
...
- Optimized/Customized/Catregorize -> Optimised/Customised/Categorise
- Github -> GitHub (80% were spelt with capital H, this is the way GitHub spells itself)
- GitPod -> Gitpod (most were without the capital P, Gitpod's site does not use capital P)
- Remove duplicate words (to to, the the)
- De-coupled -> decoupled
- implementors -> implementers (all other references used 'site implementers' so just aligning with the common case)
- Fix a/an usage in one case
- Fix one comment usage of ok, replace with OK
2023-05-30 21:07:37 +10:00
Joshua Munn
196ed4162d
Add SVG docs
2023-03-30 10:19:43 +01:00
4the4ryushin
529d2feb49
Add docs example for how to configure API renderer_classes
...
- Update docs/advanced_topics/api/v2/configuration.md
- Fixes #6066
- Fix up spelling of customise (UK English not US)
2023-01-19 20:43:45 +10:00
Sævar Öfjörð Magnússon
629b8e7a55
Add ability to easily use Form Page fields in API
...
Improve documentation. Adding information about how to retrieve form fields from the API.
Include the API fields on the form field model
2022-11-18 06:58:16 +10:00
LB Johnston
2e8709e0d6
Documentation - update dead/redirected links
2022-10-11 20:44:08 +10:00
Haydn Greatnews
02b2b7c9f2
Fix some casing code in examples in API configuration docs
2022-10-01 17:56:08 +10:00
Storm Heg
6a8ce3161e
Fix code style of example in Wagtail API docs
...
Example code should be compliant with PEP-8.
2022-09-19 21:49:01 +10:00
Christophe Bastin
5dad39fb57
docs: APIField naming ( #9173 )
2022-09-09 13:47:46 +01:00
Dolidodzik
b131b4813e
replace latin abbreviations with english phrases & updated docs guidelines
...
- added sub-section to language part of general_guidelines.md
- fixes #8860
2022-07-20 16:11:38 +10:00
LB Johnston
cda437804e
fix up markdown docs conversion issues
...
- introduced in #8759 & #8569
2022-06-30 16:36:37 +10:00
Thiago Costa de Souza
7e73349dc1
documentation - migrate api section to markdown
2022-05-25 21:01:38 +10:00