| 2010-12-15 08:57:57 |
Michael Nelson |
bug |
|
|
added bug |
| 2010-12-20 16:38:27 |
Michael Nelson |
description |
Looking at the /api/urls.py that we have, I think there are a few improvements we could make before releasing it (and supporting the api in the future):
1) Remove unnecessary verbs from url, eg 1.0/reviews/create/
This could instead be a POST action on 1.0/reviews/
2) Namespacing models, eg. 1.0/<review_id>/report-review/ has no namespace (ie. the model is ambiguous, and if later we wanted to represent moderations or other models in the api we'd have to be inconsistent).
I think this url should be namespaced, and also remove the verb, instead POSTing to 1.0/reviews/<review_id>/flags/
Similarly, creating a 'useful' recommendation for a review would be a POST to 1.0/reviews/<review_id>/recommendations/ (note plurals).
See http://en.wikipedia.org/wiki/REST#RESTful_web_services for standard restful webservice uris. |
Looking at the /api/urls.py that we have, I think there are a few improvements we could make before releasing it (and supporting the api in the future):
1) Remove unnecessary verbs from url, eg 1.0/reviews/create/
This could instead be a POST action on 1.0/reviews/
and return the new resource, rather than "Created".
2) Namespacing models, eg. 1.0/<review_id>/report-review/ has no namespace (ie. the model is ambiguous, and if later we wanted to represent moderations or other models in the api we'd have to be inconsistent).
I think this url should be namespaced, and also remove the verb, instead POSTing to 1.0/reviews/<review_id>/flags/
Similarly, creating a 'useful' recommendation for a review would be a POST to 1.0/reviews/<review_id>/recommendations/ (note plurals).
See http://en.wikipedia.org/wiki/REST#RESTful_web_services for standard restful webservice uris.
|
|
| 2011-01-03 09:10:09 |
Michael Nelson |
rnr-server: status |
New |
In Progress |
|
| 2011-01-03 09:10:12 |
Michael Nelson |
rnr-server: assignee |
|
Michael Nelson (michael.nelson) |
|
| 2011-01-04 09:09:43 |
Michael Nelson |
description |
Looking at the /api/urls.py that we have, I think there are a few improvements we could make before releasing it (and supporting the api in the future):
1) Remove unnecessary verbs from url, eg 1.0/reviews/create/
This could instead be a POST action on 1.0/reviews/
and return the new resource, rather than "Created".
2) Namespacing models, eg. 1.0/<review_id>/report-review/ has no namespace (ie. the model is ambiguous, and if later we wanted to represent moderations or other models in the api we'd have to be inconsistent).
I think this url should be namespaced, and also remove the verb, instead POSTing to 1.0/reviews/<review_id>/flags/
Similarly, creating a 'useful' recommendation for a review would be a POST to 1.0/reviews/<review_id>/recommendations/ (note plurals).
See http://en.wikipedia.org/wiki/REST#RESTful_web_services for standard restful webservice uris.
|
Looking at the /api/urls.py that we have, I think there are a few improvements we could make before releasing it (and supporting the api in the future):
1) Remove unnecessary verbs from url, eg 1.0/reviews/create/
This could instead be a POST action on 1.0/reviews/
and return the new resource, rather than "Created".
2) Namespacing models, eg. 1.0/<review_id>/report-review/ has no namespace (ie. the model is ambiguous, and if later we wanted to represent moderations or other models in the api we'd have to be inconsistent).
I think this url should be namespaced, and also remove the verb, instead POSTing to 1.0/reviews/<review_id>/flags/
Similarly, creating a 'useful' recommendation for a review would be a POST to 1.0/reviews/<review_id>/recommendations/ (note plurals).
See http://en.wikipedia.org/wiki/REST#RESTful_web_services for standard restful webservice uris.
To QA:
Since this is just a change to the API, this is QA-OK if the functionality using the api still works :). ie. reviews can be created, flagged and marked as useful. |
|
| 2011-01-04 09:09:57 |
Michael Nelson |
rnr-server: status |
In Progress |
Fix Committed |
|
| 2011-01-04 09:10:15 |
Canonical ISD bug wrangler |
tags |
|
kb-improvement |
|
| 2011-01-21 13:20:12 |
Canonical ISD bug wrangler |
rnr-server: importance |
Undecided |
Medium |
|
| 2011-01-21 15:13:37 |
Canonical ISD bug wrangler |
rnr-server: status |
Fix Committed |
Fix Released |
|
| 2011-01-21 15:41:57 |
Anthony Lenton |
rnr-server: milestone |
|
10.12 |
|
