Skip to content

Commit f0095b4

Browse files
authored
Remove Core API mentions from docs (encode#8780)
* remove coreapi generator mentions & hidden docs * remove coreapi doc & redirect broken links to github snapshot
1 parent 5435b2c commit f0095b4

11 files changed

+4
-1857
lines changed

docs/api-guide/filtering.md

-9
Original file line numberDiff line numberDiff line change
@@ -335,15 +335,6 @@ Generic filters may also present an interface in the browsable API. To do so you
335335

336336
The method should return a rendered HTML string.
337337

338-
## Filtering & schemas
339-
340-
You can also make the filter controls available to the schema autogeneration
341-
that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
342-
343-
`get_schema_fields(self, view)`
344-
345-
The method should return a list of `coreapi.Field` instances.
346-
347338
# Third party packages
348339

349340
The following third party packages provide additional filter implementations.

docs/api-guide/pagination.md

-9
Original file line numberDiff line numberDiff line change
@@ -264,15 +264,6 @@ API responses for list endpoints will now include a `Link` header, instead of in
264264

265265
*A custom pagination style, using the 'Link' header'*
266266

267-
## Pagination & schemas
268-
269-
You can also make the pagination controls available to the schema autogeneration
270-
that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
271-
272-
`get_schema_fields(self, view)`
273-
274-
The method should return a list of `coreapi.Field` instances.
275-
276267
---
277268

278269
# HTML pagination controls

docs/community/3.10-announcement.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,6 @@ continued development by **[signing up for a paid plan][funding]**.
142142

143143
*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), and [Lights On Software](https://lightsonsoftware.com).*
144144

145-
[legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/master/docs/coreapi/index.md
145+
[legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/3.14.0/docs/coreapi/index.md
146146
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
147147
[funding]: funding.md

docs/community/3.4-announcement.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ The full set of itemized release notes [are available here][release-notes].
187187
[api-blueprint]: https://apiblueprint.org/
188188
[tut-7]: ../tutorial/7-schemas-and-client-libraries/
189189
[schema-generation]: ../api-guide/schemas/
190-
[api-clients]: ../topics/api-clients.md
190+
[api-clients]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md
191191
[milestone]: https://github.com/encode/django-rest-framework/milestone/35
192192
[release-notes]: release-notes#34
193193
[metadata]: ../api-guide/metadata/#custom-metadata-classes

docs/community/3.6-announcement.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -195,5 +195,5 @@ on realtime support, for the 3.7 release.
195195
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
196196
[funding]: funding.md
197197
[api-docs]: ../topics/documenting-your-api.md
198-
[js-docs]: ../topics/api-clients.md#javascript-client-library
199-
[py-docs]: ../topics/api-clients.md#python-client-library
198+
[js-docs]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md#javascript-client-library
199+
[py-docs]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md#python-client-library

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

-242
This file was deleted.

0 commit comments

Comments
 (0)