Skip to content

Update docs related to coreapi to include deprecation notice #8186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/coreapi/7-schemas-and-client-libraries.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# 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
endpoints, their URLS, and what operations they support.

Expand Down
11 changes: 11 additions & 0 deletions docs/coreapi/from-documenting-your-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@

## 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:

* Documentation of API endpoints.
Expand Down
4 changes: 2 additions & 2 deletions docs/coreapi/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 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.

----

Expand Down
8 changes: 8 additions & 0 deletions docs/coreapi/schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ source: schemas.py

# 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.
>
> — Heroku, [JSON Schema for the Heroku Platform API][cite]
Expand Down