Skip to content

Add API documentation #2

@gabrielpreda

Description

@gabrielpreda

Add API documentation
Current implementation is using Flask and Python to create a web API

Acceptance criteria:

  • all functions exposed should have documentation
  • examples for use of each function should be provided

Note: Flask, Swagger UI and Flask-RESTPlus could be used to create a basic documentation of the existing API; here is an example: http://michal.karzynski.pl/blog/2016/06/19/building-beautiful-restful-apis-using-flask-swagger-ui-flask-restplus/

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions