Fix v3 hypervisor extension search action follow REST principles

Bug #1197419 reported by OpenStack Infra
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Medium
Kersten Richter

Bug Description

https://review.openstack.org/33774
commit 4ba82d5aa08c8715ed53955de63da70ccbaba551
Author: He Jie Xu <email address hidden>
Date: Thu Jun 20 12:57:55 2013 +0800

    Fix v3 hypervisor extension search action follow REST principles

    The original search action as below:
    '/os-hypervisors/[filters]/search'

    It doesn't follow REST principles.

    So change it as:
    '/os-hypervisors/search?query=[filters]'

    This follow the suggestion from
    http://www.slideshare.net/apigee/restful-api-design-second-edition#btnNext at 77 pages.

    Partially implements: bp v3-api-extension-versioning

    DocImpact

    Change-Id: I114868112e0dd719c046853de29df5cfa8dae6b5

Tags: compute-v3
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → havana
Changed in openstack-api-site:
milestone: none → havana
Tom Fifield (fifieldt)
Changed in openstack-api-site:
status: New → Confirmed
Changed in openstack-manuals:
status: New → Confirmed
Changed in openstack-api-site:
importance: Undecided → Medium
Changed in openstack-manuals:
importance: Undecided → Medium
Tom Fifield (fifieldt)
no longer affects: openstack-manuals
Revision history for this message
Diane Fleming (diane-fleming) wrote :

V3

Changed in openstack-api-site:
milestone: havana → icehouse
Changed in openstack-api-site:
assignee: nobody → Diane Fleming (diane-fleming)
Tom Fifield (fifieldt)
tags: added: compute-v3
removed: nova
Revision history for this message
David Hwu (bluevalor) wrote :

This is NOT the only REST API that doesn't follow existing REST principles... there are many more detailed in the OpenStack v3 API page:
http://api.openstack.org/api-ref-identity.html#identity-v3-ext
For example: v3/domains/​{domain_id}​/groups/​{group_id}​/roles/​{role_id}​

Recommend review of APIGEE video on Teaching Dog to REST... it provides basic compelling reason for good REST API design:
http://vimeo.com/17785736

Look at existing API models found in many of the existing successful API modes (like Facebook, Twitter, Twillo, etc):
https://apigee.com/console/facebook

Changed in openstack-api-site:
assignee: Diane Fleming (diane-fleming) → Kersten Richter (kersten-r)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/70184
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=e6fd8ad250610fb8254c01a3ca133e26e69c5382
Submitter: Jenkins
Branch: master

commit e6fd8ad250610fb8254c01a3ca133e26e69c5382
Author: Kersten Richter <email address hidden>
Date: Thu Jan 30 12:24:05 2014 -0600

    Nova compute v3 APIs

    Created xml pages to hold the v3 compute API extensions.
    xml files link to several different wadls, which in turn,
    call several api samples. This is not a complete listing,
    but it is a start. Will be adding others as they become available.

    Closes-Bug: #1274616
    Closes-Bug: #1197419
    Closes-Bug: #1203653

    Change-Id: Ie6d18336b46c262ce3918a9e37238f7403c75eb6

Changed in openstack-api-site:
status: In Progress → Fix Released
Revision history for this message
David Hwu (bluevalor) wrote :

Also ask using RFC 3986 standard when designing REST calls for Openstack:
URI Generic Syntax January 2005 by Berners-Lee

http://www.ietf.org/rfc/rfc3986.txt

ALL OpenStack provided REST API needs to follow these URI RFC 3986 standards

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

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