Skip to content

Commit b8bd082

Browse files
committed
Begin release announcement.
1 parent b4ec102 commit b8bd082

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

docs/community/3.10-announcement.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
# Django REST framework 3.10
3+
4+
5+
* Reworked OpenAPI schema generation.
6+
* Python 3 only.
7+
8+
9+
## OpenAPI Schema Generation.
10+
11+
Since we first introduced schema support in Django REST Framework 3.5, OpenAPI has emerged as the widely adopted standard for modelling Web APIs.
12+
13+
This release deprecates the old CoreAPI based schema generation, and introduces improved OpenAPI schema generation in its place.
14+
15+
### Deprecating CoreAPI Schema Generation.
16+
17+
The in-built docs that were introduced in Django REST Framework v3.5 were built on CoreAPI. These are now deprecated. You may continue to use them but they will be **removed in Django REST Framework v 3.12**.
18+
19+
You should migrate to using the new OpenAPI based schema generation as soon as you can.
20+
21+
22+
We have removed the old documentation for the CoreAPI based schema generation.
23+
You may view them from here:
24+
25+
TOOD: Insert links:
26+
27+
* Tutorial 7: Schemas & client libraries
28+
* Section from Documenting your API topic page.
29+
* Includes API reference for `include_docs_urls()` and supporting functions.
30+
* Schemas API Guide reference.
31+
32+
----
33+
34+
**TODO**:
35+
- Currently, `SchemaView` will keep working.
36+
- Hardcoded generator class.
37+
- `generateschema` won't work... Do we need to fix that?
38+
- Only introduced in v3.9. Not really useful for `coreapi`?
39+
- Note on (≈private) import changes.
40+
- Documented utility imports from `schemas` should be maintained.
41+
- Sub-imports can move for the code changes.
42+
43+
----
44+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ pages:
6565
- 'Contributing to REST framework': 'community/contributing.md'
6666
- 'Project management': 'community/project-management.md'
6767
- 'Release Notes': 'community/release-notes.md'
68+
- '3.10 Announcement': 'community/3.10-announcement.md'
6869
- '3.9 Announcement': 'community/3.9-announcement.md'
6970
- '3.8 Announcement': 'community/3.8-announcement.md'
7071
- '3.7 Announcement': 'community/3.7-announcement.md'

0 commit comments

Comments
 (0)