encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-27 00:19:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs related to coreapi to include deprecation notice

Browse Source
This commit is contained in:
chen 2021-09-25 20:00:28 +08:00
parent c62e3ca764
commit a9a7ff5d53
4 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/coreapi/7-schemas-and-client-libraries.md
View File

@ -1,5 +1,16 @@
# Tutorial 7: Schemas & client libraries
----
**DEPRECATION NOTICE:** As of DRF version 3.9, the plan is to phase out CoreAPI in favor of OpenAPI as the default schema representation. You can look for more details at [Version 3.9 Annoucement](../community/3.9-announcement.md).
If you are looking for information regarding schemas, you might want to look at these updated resources:
1. [Schema](../api-guide/schemas.md)
2. [Documenting your API](../topics/documenting-your-api.md)
----
A schema is a machine-readable document that describes the available API
endpoints, their URLS, and what operations they support.

11
docs/coreapi/from-documenting-your-api.md
View File

@ -1,6 +1,17 @@
## Built-in API documentation
----
**DEPRECATION NOTICE:** As of DRF version 3.9, the plan is to phase out CoreAPI in favor of OpenAPI as the default schema representation. You can look for more details at [Version 3.9 Annoucement](../community/3.9-announcement.md).
If you are looking for information regarding schemas, you might want to look at these updated resources:
1. [Schema](../api-guide/schemas.md)
2. [Documenting your API](../topics/documenting-your-api.md)
----
The built-in API documentation includes:
* Documentation of API endpoints.

4
docs/coreapi/index.md
View File

@ -1,8 +1,10 @@
# Legacy CoreAPI Schemas Docs
As of DRF version 3.9, the plan is to phase out CoreAPI in favor of OpenAPI as the default schema representation. You can look for more details at [Version 3.9 Annoucement](../community/3.9-announcement.md#whats-next).
Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation in Django REST Framework v3.10.
See the [Version 3.10 Release Announcement](/community/3.10-announcement.md) for more details.
See the [Version 3.10 Release Announcement](../community/3.10-announcement.md) for more details.
----

8
docs/coreapi/schemas.md
View File

@ -2,6 +2,14 @@ source: schemas.py
# Schemas
----
**DEPRECATION NOTICE:** As of DRF version 3.9, the plan is to phase out CoreAPI in favor of OpenAPI as the default schema representation. You can look for more details at [Version 3.9 Annoucement](../community/3.9-announcement.md).
You are probably looking for [this page](../api-guide/schemas.md) if you want latest information regarding schemas.
----
> 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.
>
> — Heroku, [JSON Schema for the Heroku Platform API][cite]