Bug 5564 - toaster document REST APIs dynamically using Swagger
Summary: toaster document REST APIs dynamically using Swagger
Status: VERIFIED WONTFIX
Alias: None
Product: Toaster
Classification: Build System, Metadata & Runtime
Component: toaster (show other bugs)
Version: 1.6
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: Future
Assignee: Alexandru Damian
QA Contact: Alexandru Roman
URL:
Whiteboard:
Depends on: 5558 5563
Blocks:
  Show dependency tree
 
Reported: 2013-11-19 12:58 UTC by Alexandru Damian
Modified: 2015-12-03 13:07 UTC (History)
6 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Alexandru Damian 2013-11-19 12:58:23 UTC 
REST APIs for Toaster are in continous development, and may easily change from version to version, possibly making the old versions unmaintainable.

Integrating Swagger https://github.com/marcgibbons/django-rest-swagger will leads us to having self-documenting APIs that will make development of other tools on top of Toaster easier.

We need to point to the self documenting APIs in our manuals.
Comment 1 Alexandru Damian 2015-04-10 15:42:07 UTC 
Will not use swagger for self-documenting APIs.

Swagger is based on the django rest framework, which is not used in Toaster. Therefore the implementation request is pointless.
Comment 2 Alexandru Roman 2015-12-03 13:07:47 UTC 
Verified.