Fix API XML/JSON and REST inconsistencies

Registered by Christopher Yeoh on 2013-04-19

Fix XML/JSON inconsistencies.
FIx extensions which don't follow REST principles (eg put must be idempotent)

Blueprint information

Status:
Started
Approver:
Russell Bryant
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
Christopher Yeoh
Definition:
Drafting
Series goal:
None
Implementation:
Needs Code Review
Milestone target:
None
Started by
Thierry Carrez on 2013-05-14

Related branches

Sprints

Whiteboard

Need to audit of all extensions for the above. Add entries below as they are found

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

Addressed by: https://review.openstack.org/28675
    fix the XML/JSON inconsistence in service api

Addressed by: https://review.openstack.org/30220
    fix the XML/JSON inconsistence in api cloudpipe:create

The current API uses both underscores and CamelCase http://<email address hidden>/msg23320.html we should make sure to fix these for V3 API. ~jogo may 30th, 2013

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

Addressed by: https://review.openstack.org/31924
    Port service API to v3 Part 2 and fix xml/json inconsistance issue

Addressed by: https://review.openstack.org/32326
    port Host API into v3 part2

Addressed by: https://review.openstack.org/36174
    Port service API to v3 Part 2

Addressed by: https://review.openstack.org/57610
    Use 'tenant_id' instead of 'project_id' for instance-actions v3

Addressed by: https://review.openstack.org/57612
    Use tenant instead of project for hosts v3

Addressed by: https://review.openstack.org/58218
    Add 'extra_specs' as root key for flavor extra_specs update in v3

Addressed by: https://review.openstack.org/43715
    Add decorator expected_errors for flavors_extraspecs v3

Addressed by: https://review.openstack.org/58292
    Use 'project' instead of 'tenant' for v3 server's query parameters

Addressed by: https://review.openstack.org/58443
    Use 'project' instead of 'tenant' for the response of simple_tenant_usage v3

Addressed by: https://review.openstack.org/58444
    Rename v3 extension simple_tenant_usage to simple_project_usage

Addressed by: https://review.openstack.org/58450
    Use 'project' instead of 'tenant' for flavor-access v3

Addressed by: https://review.openstack.org/58458
    Use 'project_id' instead of 'tenant_id' for the response of servers v3

Addressed by: https://review.openstack.org/68026
    Fix scheduler_hints parameter of v3 API

Addressed by: https://review.openstack.org/72838
    Remove the Retry-After from v3 APIs

We're deferring v3 API blueprints to Juno at this point. --russellb

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 --johnthetubaguyNeed to audit of all extensions for the above. Add entries below as they are found

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

Addressed by: https://review.openstack.org/28675
    fix the XML/JSON inconsistence in service api

Addressed by: https://review.openstack.org/30220
    fix the XML/JSON inconsistence in api cloudpipe:create

The current API uses both underscores and CamelCase http://<email address hidden>/msg23320.html we should make sure to fix these for V3 API. ~jogo may 30th, 2013

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

Addressed by: https://review.openstack.org/31924
    Port service API to v3 Part 2 and fix xml/json inconsistance issue

Addressed by: https://review.openstack.org/32326
    port Host API into v3 part2

Addressed by: https://review.openstack.org/36174
    Port service API to v3 Part 2

Addressed by: https://review.openstack.org/57610
    Use 'tenant_id' instead of 'project_id' for instance-actions v3

Addressed by: https://review.openstack.org/57612
    Use tenant instead of project for hosts v3

Addressed by: https://review.openstack.org/58218
    Add 'extra_specs' as root key for flavor extra_specs update in v3

Addressed by: https://review.openstack.org/43715
    Add decorator expected_errors for flavors_extraspecs v3

Addressed by: https://review.openstack.org/58292
    Use 'project' instead of 'tenant' for v3 server's query parameters

Addressed by: https://review.openstack.org/58443
    Use 'project' instead of 'tenant' for the response of simple_tenant_usage v3

Addressed by: https://review.openstack.org/58444
    Rename v3 extension simple_tenant_usage to simple_project_usage

Addressed by: https://review.openstack.org/58450
    Use 'project' instead of 'tenant' for flavor-access v3

Addressed by: https://review.openstack.org/58458
    Use 'project_id' instead of 'tenant_id' for the response of servers v3

Addressed by: https://review.openstack.org/68026
    Fix scheduler_hints parameter of v3 API

Addressed by: https://review.openstack.org/72838
    Remove the Retry-After from v3 APIs

We're deferring v3 API blueprints to Juno at this point. --russellb

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

Work items:
Audit extensions for relevant bugs: TODO
os-services/enable xml does not work: TODO
os-cloudpipe create response: TODO

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.