Nailgun API doc build is incorrect

Bug #1262680 reported by Aleksey Kasatkin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Released
Medium
Aleksey Kasatkin

Bug Description

The documentation is built for Nailgun API contain errors. Build logic seems to be incorrect.
Problems found:
1. Only part of API urls are present.
2. Some classes which have no url (so they are not the part of API) are present.
3. Some API handlers are without methods (but they have methods really).

See http://docs.mirantis.com/fuel-dev/develop/api_doc.html

Fresh build from master gives results with the same problems.
Problems 2, 3 are found in section 6.5. Network Configuration API.

Tags: docs nailgun
Changed in fuel:
importance: Undecided → Medium
Revision history for this message
Ivan Kolodyazhny (e0ne) wrote :

It would be great to have unit tests for autoapidoc.py and forgot about such problems

tags: added: docs nailgun
Changed in fuel:
assignee: nobody → Fuel Python Team (fuel-python)
Ivan Kolodyazhny (e0ne)
Changed in fuel:
status: New → Confirmed
Mike Scherbakov (mihgen)
Changed in fuel:
milestone: none → 4.0
Changed in fuel:
assignee: Fuel Python Team (fuel-python) → Aleksey Kasatkin (alekseyk-ru)
Changed in fuel:
milestone: 4.0 → 4.1
Changed in fuel:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-web (master)

Reviewed: https://review.openstack.org/63948
Committed: https://git.openstack.org/cgit/stackforge/fuel-web/commit/?id=22f9497fb68e6a7623759c202dcf66633cb2c36d
Submitter: Jenkins
Branch: master

commit 22f9497fb68e6a7623759c202dcf66633cb2c36d
Author: Aleksey Kasatkin <email address hidden>
Date: Tue Dec 24 18:26:23 2013 +0200

    API DOC generation issues fixed

    1. Some handler class definitions are fixed.
    2. API DOC generation issues fixed (listed in corresponding bug description).
    3. Some API DOC generation tests are added.

    Closes-Bug: #1262680

    Change-Id: I52e7254b6f405b07e77a1dc79155445f24d6288a

Changed in fuel:
status: In Progress → Fix Committed
Revision history for this message
Andrey Sledzinskiy (asledzinskiy) wrote :
Changed in fuel:
status: Fix Committed → Fix Released
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.