Skip to content

Commit 47ee3fc

Browse files
authored
Update docs related to coreapi to include deprecation notice (encode#8186)
* Update docs related to coreapi to include deprecation notice * Update docs to use reference to version 3.10 release notes instead of 3.9
1 parent b0d407f commit 47ee3fc

File tree

4 files changed

+32
-2
lines changed

4 files changed

+32
-2
lines changed

docs/coreapi/7-schemas-and-client-libraries.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Tutorial 7: Schemas & client libraries
22

3+
----
4+
5+
**DEPRECATION NOTICE:** Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation as of Django REST Framework v3.10. See the [Version 3.10 Release Announcement](../community/3.10-announcement.md) for more details.
6+
7+
If you are looking for information regarding schemas, you might want to look at these updated resources:
8+
9+
1. [Schema](../api-guide/schemas.md)
10+
2. [Documenting your API](../topics/documenting-your-api.md)
11+
12+
----
13+
314
A schema is a machine-readable document that describes the available API
415
endpoints, their URLS, and what operations they support.
516

docs/coreapi/from-documenting-your-api.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11

22
## Built-in API documentation
33

4+
----
5+
6+
**DEPRECATION NOTICE:** Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation as of Django REST Framework v3.10. See the [Version 3.10 Release Announcement](../community/3.10-announcement.md) for more details.
7+
8+
If you are looking for information regarding schemas, you might want to look at these updated resources:
9+
10+
1. [Schema](../api-guide/schemas.md)
11+
2. [Documenting your API](../topics/documenting-your-api.md)
12+
13+
----
14+
415
The built-in API documentation includes:
516

617
* Documentation of API endpoints.

docs/coreapi/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Legacy CoreAPI Schemas Docs
22

3-
Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation in Django REST Framework v3.10.
3+
Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation as of Django REST Framework v3.10.
44

5-
See the [Version 3.10 Release Announcement](/community/3.10-announcement.md) for more details.
5+
See the [Version 3.10 Release Announcement](../community/3.10-announcement.md) for more details.
66

77
----
88

docs/coreapi/schemas.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@ source: schemas.py
22

33
# Schemas
44

5+
----
6+
7+
**DEPRECATION NOTICE:** Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation as of Django REST Framework v3.10. See the [Version 3.10 Release Announcement](../community/3.10-announcement.md) for more details.
8+
9+
You are probably looking for [this page](../api-guide/schemas.md) if you want latest information regarding schemas.
10+
11+
----
12+
513
> A machine-readable [schema] describes what resources are available via the API, what their URLs are, how they are represented and what operations they support.
614
>
715
> — Heroku, [JSON Schema for the Heroku Platform API][cite]

0 commit comments

Comments
 (0)