Improvements to restful API
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Ratings and Reviews server |
Fix Released
|
Medium
|
Michael Nelson |
Bug 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_
I think this url should be namespaced, and also remove the verb, instead POSTing to 1.0/reviews/
Similarly, creating a 'useful' recommendation for a review would be a POST to 1.0/reviews/
See http://
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.
description: | updated |
Changed in rnr-server: | |
status: | New → In Progress |
assignee: | nobody → Michael Nelson (michael.nelson) |
description: | updated |
Changed in rnr-server: | |
status: | In Progress → Fix Committed |
tags: | added: kb-improvement |
Changed in rnr-server: | |
importance: | Undecided → Medium |
Changed in rnr-server: | |
status: | Fix Committed → Fix Released |
Changed in rnr-server: | |
milestone: | none → 10.12 |
I can't see a way to trigger the marked as useful via SC so am assuming this can only be done via api calls presently