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

Update docs related to coreapi to include deprecation notice (#8186)

Browse Source 
* Update docs related to coreapi to include deprecation notice

* Update docs to use reference to version 3.10 release notes instead of 3.9
This commit is contained in:
Chen Wen Kang 2021-12-08 22:38:42 +08:00 committed by GitHub
parent b0d407fd63
commit 47ee3fc9a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 2 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 # Tutorial 7: Schemas & client libraries
----
**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.
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 A schema is a machine-readable document that describes the available API
endpoints, their URLS, and what operations they support. 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 ## Built-in API documentation
----
**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.
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: The built-in API documentation includes:
* Documentation of API endpoints. * Documentation of API endpoints.

4
docs/coreapi/index.md
View File

@ -1,8 +1,8 @@
# Legacy CoreAPI Schemas Docs # Legacy CoreAPI Schemas Docs
Use of CoreAPI-based schemas were deprecated with the introduction of native OpenAPI-based schema generation in Django REST Framework v3.10. 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. 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 # Schemas
----
**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.
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. > 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] > — Heroku, [JSON Schema for the Heroku Platform API][cite]