Bug 5564

Summary: toaster document REST APIs dynamically using Swagger
Product: [Build System, Metadata & Runtime] Toaster Reporter: Alexandru Damian <alexandru.damian>
Component: toasterAssignee: Alexandru Damian <alexandru.damian>
Status: VERIFIED WONTFIX QA Contact: Alexandru Roman <alexandru.costinx.roman>
Severity: enhancement    
Priority: Medium CC: alexandru.costinx.roman, alexandru.damian, andreea.b.proca, belen.barros.pena, cristiana.voicu, jessica.zhang
Version: 1.6   
Target Milestone: Future   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)
Bug Depends on: 5558, 5563    
Bug Blocks:    

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.