description="Proof of concept", parameters=[ swagger.PathParameter( name="id", description="root id", allow_empty_value=True, schema=swagger.Schema( type="string", format="email", ), ), swagger.QueryParameter(name="age", description="age of user", schema=swagger.Integer()), ], responses={"200": swagger.ResponseObject(description="Echos whatever")}, ) info = swagger.Info( title="Test", version="1.2.2", contact=swagger.Contact(name="nuke", email="*****@*****.**", url="https://github.com/kulgan"), license=swagger.License(name="Apache 2.0", url="https://www.example.com/license"), ) tags = [ swagger.Tag(name="getEcho", description="gets echos no matter where they are hiding"),
request_body=swagger.RequestBody( content=swagger.MediaType( content_type="multipart/form-data", schema=swagger.Schema( properties=dict( file=swagger.BinaryString(description="file to upload"), additional_metadata=swagger.String( description="additional data to pass to server" ), ) ), ) ), responses={ "200": swagger.ResponseObject( description="successful operation", content=swagger.JsonType(schema=ApiResponse), ) }, security=[{"petstore_auth": ["write:pets", "read:pets"]}], ) update_pet_spec = swagger.PUT( tags=["pet"], summary="Update an existing pet", operation_id="updatePet", request_body=swagger.RequestBody( content=[swagger.JsonType(schema=Pet), swagger.XmlType(schema=Pet)], required=True, ), responses={
from flaskdoc import swagger from flaskdoc.examples.link_example import schemas get_user_by_name = swagger.GET( operation_id="getUserByName", parameters=[swagger.PathParameter(name="username", schema=str)], responses={ "200": swagger.ResponseObject( description="The User", content=swagger.JsonType(schema=schemas.User), links={ "userRepositories": swagger.LinkReference("UserRepositories") }, ) }, ) get_repository_by_owner = swagger.GET( operation_id="getRepositoryByOwner", parameters=[swagger.PathParameter(name="username", schema=str)], responses={ "200": swagger.ResponseObject( description="repositories owned by the supplied user", content=swagger.JsonType(schema=[schemas.Repository]), links={"userRepository": swagger.LinkReference("UserRepository")}, ) }, )
), swagger.QueryParameter( name="skip", schema=int, description="number of records to skip for pagination", ), swagger.QueryParameter( name="limit", schema=swagger.Integer(maximum=50), description="maximum number of records to return", ), ], responses={ "200": swagger.ResponseObject( description="search results matching criteria", content=swagger.JsonType(schema=[InventoryItem]), ), "400": swagger.ResponseObject(description="bad input parameter"), }, ) add_inventory_docs = swagger.POST( tags=["admin"], operation_id="addInventory", summary="adds an inventory item", description="adds an item to the system", request_body=swagger.RequestBody( content=swagger.JsonType(schema=InventoryItem), description="Inventory item to add", ),
"rel": "describedby", }, ], } }), } @swagger.GET( tags=["listVersionsv2"], summary="List API versions", responses={ "200": swagger.ResponseObject( description="200 response", content=swagger.JsonType( examples={"foo": swagger.ExampleReference("foo")}), ), "300": swagger.ResponseObject( description="300 response", content=swagger.JsonType( examples={"foo": swagger.ExampleReference("foo")}), ), }, ) @api.route("/", methods=["GET"]) def root(): return flask.jsonify(examples["foo"])