Convert API Reference to RST and host it in the Nova tree (Pike)

Registered by Matt Riedemann on 2017-02-03

Blueprint information

Status:
Complete
Approver:
Matt Riedemann
Priority:
Medium
Drafter:
Matt Riedemann
Direction:
Approved
Assignee:
None
Definition:
Approved
Series goal:
Accepted for pike
Implementation:
Implemented
Milestone target:
milestone icon pike-2
Started by
Matt Riedemann on 2017-03-10
Completed by
Matt Riedemann on 2017-08-03

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/api-ref-in-rst-pike,n,z

Addressed by: https://review.openstack.org/338606
    Complete verification of servers-action-fixed-ip.inc

Addressed by: https://review.openstack.org/383691
    api-ref: Body verification for os-hypervisors.inc

Gerrit topic: https://review.openstack.org/#q,topic:bp/api-ref-in-rst-ocata,n,z

Addressed by: https://review.openstack.org/398197
    api-ref: body verification for os-hypervisors

Addressed by: https://review.openstack.org/442981
    Clean up metadata param in doc

Addressed by: https://review.openstack.org/442984
    remove a TODO as all set for tags

Addressed by: https://review.openstack.org/338051
    api-ref: Complete all the verifications of remote consoles

Addressed by: https://review.openstack.org/450141
    Fix 'server' and 'instance' togetger in api-ref

Gerrit topic: https://review.openstack.org/#q,topic:bug/1677452,n,z

Addressed by: https://review.openstack.org/451645
    api-ref: Fix wrong HTTP response codes

Addressed by: https://review.openstack.org/446471
    Add server-action-removefloatingip.json file and update servers-actions.inc

Addressed by: https://review.openstack.org/453026
    api-ref: Add a removeFloatingIp example

Addressed by: https://review.openstack.org/454565
    api-ref: Example verification for servers-actions.inc

Addressed by: https://review.openstack.org/455563
    api-ref: Parameter verification for servers-actions (1/4)

Addressed by: https://review.openstack.org/455568
    api-ref: Parameter verification for servers-actions (2/4)

Addressed by: https://review.openstack.org/455570
    api-ref: Parameter verification for servers-actions (3/4)

Addressed by: https://review.openstack.org/455573
    api-ref: Parameter verification for servers-actions (4/4)

Addressed by: https://review.openstack.org/456053
    api-ref: Fix examples for add/removeFixedIp action

Gerrit topic: https://review.openstack.org/#q,topic:bug/1683264,n,z

Addressed by: https://review.openstack.org/457167
    api-ref: Fix response code and parameters in evacuate

Addressed by: https://review.openstack.org/458713
    api-ref: Fix parameters in servers-action-console-output

Addressed by: https://review.openstack.org/458717
    api-ref: Use 'note' directive

Gerrit topic: https://review.openstack.org/#q,topic:bug/1685977,n,z

Addressed by: https://review.openstack.org/459494
    api-ref: Fix a parameter description in servers.inc

Gerrit topic: https://review.openstack.org/#q,topic:bug/1686917,n,z

Addressed by: https://review.openstack.org/460866
    api-ref: Fix unnecessary description in servers-admin-action

Addressed by: https://review.openstack.org/467099
    api-ref: Fix parameter order in os-services.inc

Gerrit topic: https://review.openstack.org/#q,topic:bug/1693555,n,z

Addressed by: https://review.openstack.org/474847
    api-ref: Add X-OpenStack-Request-Id description

Gerrit topic: https://review.openstack.org/#q,topic:bug/1668747,n,z

Addressed by: https://review.openstack.org/474879
    api-ref: Verify parameters in os-migrations.inc

Gerrit topic: https://review.openstack.org/#q,topic:bug/1654316,n,z

Addressed by: https://review.openstack.org/475640
    api-ref: Add missing parameters in limits.inc

Gerrit topic: https://review.openstack.org/#q,topic:bug/1699732,n,z

Addressed by: https://review.openstack.org/476434
    api-ref: Fix parameters in server-security-groups

I'm going to consider this done for Pike as there are no more open changes. The remaining items are mostly for deprecated APIs anyway, and we can probably fix the rest of the os-servers APIs with bug fixes. -- mriedem 20170803

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.