Add automatically generated API documentation

Bug #1449030 reported by Przemyslaw Kaminski
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Triaged
Low
Fuel Sustaining
Mitaka
Won't Fix
Low
Fuel Python (Deprecated)
Newton
Triaged
Low
Fuel Sustaining

Bug Description

We should have an automatic way of generating API docs. The preferred one is Swagger [1]. You can see a demo here [2]. This will help to quickly find the appropriate request and its parameters, also will help us clean up and unify our API (status codes, return types etc).

[1] http://swagger.io/
[2] http://petstore.swagger.io/

Dmitry Pyzhov (dpyzhov)
Changed in fuel:
status: New → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-web (master)

Fix proposed to branch: master
Review: https://review.openstack.org/179051

Changed in fuel:
assignee: Fuel Python Team (fuel-python) → Przemyslaw Kaminski (pkaminski)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on fuel-web (master)

Change abandoned by Igor Shishkin (<email address hidden>) on branch: master
Review: https://review.openstack.org/179051
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

tags: added: feature
Changed in fuel:
status: In Progress → Confirmed
importance: High → Wishlist
assignee: Przemyslaw Kaminski (pkaminski) → Fuel Python Team (fuel-python)
Dmitry Pyzhov (dpyzhov)
Changed in fuel:
milestone: 7.0 → 8.0
Changed in fuel:
importance: Wishlist → Low
status: Confirmed → Triaged
Dmitry Pyzhov (dpyzhov)
tags: added: area-python
Revision history for this message
Alexander Kislitsky (akislitsky) wrote :

We passed SCF in 8.0. Moving the bug to 9.0.

Changed in fuel:
milestone: 8.0 → 9.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.