879545 - Add an API endpoint for a developer to respond to a conversation thread

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, defect, P2)

Description

[Christopher Van Wiemeersch [:cvan]]

As a developer, I will respond to a thread from `/communication`. The front end will POST to the API to add a new note to a conversation thread. Keep in mind that this API endpoint will also be used by the email-reply machine (bug 879412).

Comment 1

[Ashish Dubey [:ashish_d]]

My approach to the RESTful design of this API (which will consider reading from a thread too) suggests we should have an endpoint like -

GET /api/thread/<thread_id> - to enlist a thread, i.e. all the notes created within the thread.
POST /api/thread/<thread_id> - to modify a thread, i.e. create a new note within the thread.

We can then similarly use the same url -
PUT /api/thread/ - To create a new fresh thread.

Can we do better or we stick to this one?

Comment 2

[Andy McKay]

We've been using POST to create and PATCH or PUT to modify or update an object.

http://firefox-marketplace-api.readthedocs.org/en/latest/topics/overview.html#verbs

Comment 3

[Ashish Dubey [:ashish_d]]

Commit: https://github.com/mozilla/zamboni/commit/37f3a4a

Comment 4

[Iulian Timis]

Please add STR here or mark it with [qa-] if no QA is needed.