Skip to content

Commit fae7e91

Browse files
stephenfincarltongibson
authored andcommitted
docs: Remove references to drf-openapi (#6272)
This has been EOL'd in favour of drf-yasg [1]. [1] limdauto/drf_openapi@1673c6e0 Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent d59a130 commit fae7e91

File tree

2 files changed

+0
-18
lines changed

2 files changed

+0
-18
lines changed

docs/img/drf-openapi.png

-73.6 KB
Binary file not shown.

docs/topics/documenting-your-api.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -193,22 +193,6 @@ This also translates into a very useful interactive documentation viewer in the
193193

194194
![Screenshot - drf-yasg][image-drf-yasg]
195195

196-
197-
#### DRF OpenAPI
198-
199-
[DRF OpenAPI][drf-openapi] bridges the gap between OpenAPI specification and tool chain with the schema exposed
200-
out-of-the-box by Django Rest Framework. Its goals are:
201-
202-
* To be dropped into any existing DRF project without any code change necessary.
203-
* Provide clear disctinction between request schema and response schema.
204-
* Provide a versioning mechanism for each schema. Support defining schema by version range syntax, e.g. >1.0, <=2.0
205-
* Support multiple response codes, not just 200
206-
* All this information should be bound to view methods, not view classes.
207-
208-
It also tries to stay current with the maturing schema generation mechanism provided by DRF.
209-
210-
![Screenshot - DRF OpenAPI][image-drf-openapi]
211-
212196
---
213197

214198
#### DRF Docs
@@ -338,8 +322,6 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
338322
[cite]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
339323
[drf-yasg]: https://github.com/axnsan12/drf-yasg/
340324
[image-drf-yasg]: ../img/drf-yasg.png
341-
[drf-openapi]: https://github.com/limdauto/drf_openapi/
342-
[image-drf-openapi]: ../img/drf-openapi.png
343325
[drfdocs-repo]: https://github.com/ekonstantinidis/django-rest-framework-docs
344326
[drfdocs-website]: https://www.drfdocs.com/
345327
[drfdocs-demo]: http://demo.drfdocs.com/

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy