incubator-wookie-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Scott Wilson (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (WOOKIE-34) Accept/reject REST API proposal for getting/creating widgets
Date Fri, 10 Jun 2011 09:22:59 GMT

     [ https://issues.apache.org/jira/browse/WOOKIE-34?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Scott Wilson updated WOOKIE-34:
-------------------------------

    Description: 
A while ago we proposed making changes to the Widget Instances API to be more REST-like in
its behaviour, while still supporting legacy clients.

The main changes are (1) the addition of GET methods to retrieve a Widget Instance already
created and (2) a change in documentation for the POST method to offer a deprecation warning
for using it as get-or-create. (PUT is not altered).

Proposed changes to the API:

1. GET {wookie}/widgetinstances/{instance id} {api_key}

Returns the representation of a widget instance.

If the widget instance was not created using the provided api_key, then a 403 Forbidden status
code will be returned.

If no widget instance is found, a 404 Not Found status code will be returned.

2. GET {wookie}/widgetinstances {instance params} 

Returns the representation of the instance for the given parameters.

If the widget instance was not created using the provided api_key, then a 403 Forbidden status
code will be returned.

If no widget instance is found, a 404 Not Found status code will be returned.

3. POST {wookie}/widgetinstances {instance params}

Create a new widget instance using the given parameters. If a new widget instance is succesfully
created, a status code of 201 is returned along with the widget instance represented in XML.

If an instance already exists for the given parameters, this method will return a status code
of 200 along with the existing instance (this is intended to support legacy clients). Note
this is DEPRECATED behaviour, and future versions of the API may simply return an error code.


  was:
See http://cwiki.apache.org/confluence/display/WOOKIE/strawman+for+0.8.2

See also discussion in mailing lists (no link at present lists not indexed)

We need to agree or reject this proposal. If agreed then it needs to be implmented.


I've put the text of the proposed changes in here as it doesn't make much sense having it
separate on the wiki.

> Accept/reject REST API proposal for getting/creating widgets
> ------------------------------------------------------------
>
>                 Key: WOOKIE-34
>                 URL: https://issues.apache.org/jira/browse/WOOKIE-34
>             Project: Wookie
>          Issue Type: Improvement
>    Affects Versions: 0.9.0
>            Reporter: Ross Gardler
>            Priority: Critical
>             Fix For: 0.9.1
>
>   Original Estimate: 5h
>  Remaining Estimate: 5h
>
> A while ago we proposed making changes to the Widget Instances API to be more REST-like
in its behaviour, while still supporting legacy clients.
> The main changes are (1) the addition of GET methods to retrieve a Widget Instance already
created and (2) a change in documentation for the POST method to offer a deprecation warning
for using it as get-or-create. (PUT is not altered).
> Proposed changes to the API:
> 1. GET {wookie}/widgetinstances/{instance id} {api_key}
> Returns the representation of a widget instance.
> If the widget instance was not created using the provided api_key, then a 403 Forbidden
status code will be returned.
> If no widget instance is found, a 404 Not Found status code will be returned.
> 2. GET {wookie}/widgetinstances {instance params} 
> Returns the representation of the instance for the given parameters.
> If the widget instance was not created using the provided api_key, then a 403 Forbidden
status code will be returned.
> If no widget instance is found, a 404 Not Found status code will be returned.
> 3. POST {wookie}/widgetinstances {instance params}
> Create a new widget instance using the given parameters. If a new widget instance is
succesfully created, a status code of 201 is returned along with the widget instance represented
in XML.
> If an instance already exists for the given parameters, this method will return a status
code of 200 along with the existing instance (this is intended to support legacy clients).
Note this is DEPRECATED behaviour, and future versions of the API may simply return an error
code.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message