]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
:memo: Clarify docs, alternatives, about APISpec OAI versions
authorSebastián Ramírez <tiangolo@gmail.com>
Mon, 14 Jan 2019 17:26:29 +0000 (21:26 +0400)
committerSebastián Ramírez <tiangolo@gmail.com>
Mon, 14 Jan 2019 17:26:29 +0000 (21:26 +0400)
docs/alternatives.md

index 404c4f5205ef628a08461c5b2e81c6418ce1bd49..ab0c099b1384e641148014b51629f36079cdd046 100644 (file)
@@ -121,7 +121,7 @@ It is a plug-in for many frameworks (and there's a plug-in for Starlette too).
 
 The way it works is that you write the definition of the schema using YAML format inside the docstring of each function handling a route.
 
-And it generates Swagger 2.0 schemas (OpenAPI 2.0).
+And it generates OpenAPI schemas.
 
 That's how it works in Flask, Starlette, Responder, etc.
 
@@ -140,7 +140,7 @@ The editor can't help much with that. And if we modify parameters or Marshmallow
 
 It's a Flask plug-in, that ties together Webargs, Marshmallow and APISpec.
 
-It uses the information from Webargs and Marshmallow to automatically generate Swagger 2.0 schemas, using APISpec.
+It uses the information from Webargs and Marshmallow to automatically generate OpenAPI schemas, using APISpec.
 
 It's a great tool, very under-rated. It should be way more popular than many Flask plug-ins out there. It might be due to its documentation being too concise and abstract.