Specification documentation for the v3 API

Registered by Christopher Yeoh on 2013-05-02

Produce documentation for api.openstack.org for the v3 API and http://docs.openstack.org/api/openstack-compute/2/content/

I think this all flows on from test_api_samples unittests, but there is also likely work required from the documentation team as well. Will need to confirm.

Blueprint information

Status:
Started
Approver:
Russell Bryant
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
Christopher Yeoh
Definition:
Drafting
Series goal:
None
Implementation:
Good progress
Milestone target:
None
Started by
Christopher Yeoh

Related branches

Sprints

Whiteboard

Documentation should show where they extend core functionality (such as parameters passed to instance creation) and how they can be accessed.

Gerrit topic: https://review.openstack.org/#q,topic:bp/v3-api-specification,n,z

Addressed by: https://review.openstack.org/39007
    v3 API samples for servers

Addressed by: https://review.openstack.org/38731
    Adds infra for v3 API sample creation

Addressed by: https://review.openstack.org/40168
    Adds v3 API samples for hosts extension

Addressed by: https://review.openstack.org/40169
    Create metafiles for API v3 samples

Gerrit topic: https://review.openstack.org/#q,topic:bp/v3-api-unittests,n,z

Addressed by: https://review.openstack.org/38608
    Refactor integrated tests to support V2 and V3 API testing

Addressed by: https://review.openstack.org/41341
    Adds V3 API samples for coverage, user-data and scheduler hints

Addressed by: https://review.openstack.org/41350
    Adds V3 API samples for agents, aggregates and certificates

Addressed by: https://review.openstack.org/41594
    Adds V3 API samples for srvcs, tenant usage, server_diagnostics

Addressed by: https://review.openstack.org/41676
    Adds V3 API samples for rmote consoles, deferred delete and baremetal

Addressed by: https://review.openstack.org/44420
    Adds V3 API samples for evacuate,extended-availability-zone,extended-server-attributes

Addressed by: https://review.openstack.org/44696
    Adds V3 API samples for cells, multinic and server-usage

Addressed by: https://review.openstack.org/45199
    Adds V3 API samples for attch-intrfcs, console_output and disk config

Addressed by: https://review.openstack.org/45670
    Adds v3 API samples for hide server addresses and keypairs

Addressed by: https://review.openstack.org/45687
    Adds v3 API samples for limits and simple tenant usage

Addressed by: https://review.openstack.org/51769
    Adds V3 API samples for console output

Addressed by: https://review.openstack.org/51771
    Adds V3 API samples for the disk-config extension

Addressed by: https://review.openstack.org/53066
    Add v3 api samples for availability_zone

Addressed by: https://review.openstack.org/45986
    Add V3 API samples for config-drive

Addressed by: https://review.openstack.org/54223
    Add v3 api samples for scheduler-hints

Addressed by: https://review.openstack.org/54234
    Add v3 api samples for shelve

Addressed by: https://review.openstack.org/54269
    Add v3 api samples for coverage

Addressed by: https://review.openstack.org/57102
    Fix sample parameter of agent API

Unapproved - please re-submit via nova-spec --johnthetubagy (20th March 2014)

Removed from next, as next is now reserved for near misses from the last milestone --johnthetubaguyDocumentation should show where they extend core functionality (such as parameters passed to instance creation) and how they can be accessed.

Gerrit topic: https://review.openstack.org/#q,topic:bp/v3-api-specification,n,z

Addressed by: https://review.openstack.org/39007
    v3 API samples for servers

Addressed by: https://review.openstack.org/38731
    Adds infra for v3 API sample creation

Addressed by: https://review.openstack.org/40168
    Adds v3 API samples for hosts extension

Addressed by: https://review.openstack.org/40169
    Create metafiles for API v3 samples

Gerrit topic: https://review.openstack.org/#q,topic:bp/v3-api-unittests,n,z

Addressed by: https://review.openstack.org/38608
    Refactor integrated tests to support V2 and V3 API testing

Addressed by: https://review.openstack.org/41341
    Adds V3 API samples for coverage, user-data and scheduler hints

Addressed by: https://review.openstack.org/41350
    Adds V3 API samples for agents, aggregates and certificates

Addressed by: https://review.openstack.org/41594
    Adds V3 API samples for srvcs, tenant usage, server_diagnostics

Addressed by: https://review.openstack.org/41676
    Adds V3 API samples for rmote consoles, deferred delete and baremetal

Addressed by: https://review.openstack.org/44420
    Adds V3 API samples for evacuate,extended-availability-zone,extended-server-attributes

Addressed by: https://review.openstack.org/44696
    Adds V3 API samples for cells, multinic and server-usage

Addressed by: https://review.openstack.org/45199
    Adds V3 API samples for attch-intrfcs, console_output and disk config

Addressed by: https://review.openstack.org/45670
    Adds v3 API samples for hide server addresses and keypairs

Addressed by: https://review.openstack.org/45687
    Adds v3 API samples for limits and simple tenant usage

Addressed by: https://review.openstack.org/51769
    Adds V3 API samples for console output

Addressed by: https://review.openstack.org/51771
    Adds V3 API samples for the disk-config extension

Addressed by: https://review.openstack.org/53066
    Add v3 api samples for availability_zone

Addressed by: https://review.openstack.org/45986
    Add V3 API samples for config-drive

Addressed by: https://review.openstack.org/54223
    Add v3 api samples for scheduler-hints

Addressed by: https://review.openstack.org/54234
    Add v3 api samples for shelve

Addressed by: https://review.openstack.org/54269
    Add v3 api samples for coverage

Addressed by: https://review.openstack.org/57102
    Fix sample parameter of agent API

Unapproved - please re-submit via nova-spec --johnthetubagy (20th March 2014)

Removed from next, as next is now reserved for near misses from the last milestone --johnthetubaguy

Marking this blueprint as definition: Drafting. If you are still working on this, please re-submit via nova-specs. If not, please mark as obsolete, and add a quick comment to describe why. --johnthetubaguy (20th April 2014)

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.