Hi,

On Wed, Aug 14, 2013 at 6:42 PM, Ramith Jayasinghe <[email protected]> wrote:

> Hi,
> This is what we propose as the URL scheme for issue tracking component we
> are writing.
>
> GET /issue/<id>  -- Returns information about an issue.
>
POST /issue/<id>/ -- modifies an existing issue.
>
> POST /issue/<id>/comment -- adds new comment to an issue
> POST /issue/<id>/comment/<id> -- modifies an  existing comment
>
> DELETE /issue/<id>/comment/<id> -- deletes  a existing comment
>
>
If we really think about the usecase I think getting a comment alone is not
the usecase rather  getting the overall issue details is the real scenario.
For exmample GET /issue/<id> should return all of it's comments as well.
This would mean one rest call for loading the issue page, so end result
coarse API instead of chatty API. For the sake of completeness we can
return the comments also but it can wait till the second cut.

thanks,
dimuthu


>
> GET  /project  -- returns a list of projects for the organization
> GET  /project/<id> --- gets information about project
>
>
> POST /project/  -- adds a new project
> POST /project/<id> -- edits information of an exiting project
>
> GET /project/<id>/version -- list of versions of the project
> GET /project/<id>/issue  -- list of issues of the project
>
>
> POST /project/<id>/issue/  -- add a new issue to an project.
>
>
> These are only the basic operations we might need (we will devise URL as
> we go along for other use cases).
> Note that above URLs don't have organization Id included.
>
> WDYT?
>

>
>
> regards
> Ramith
>



-- 
Dimuthu Leelarathne
Architect & Product Lead of App Factory

WSO2, Inc. (http://wso2.com)
email: [email protected]
Mobile : 0773661935

Lean . Enterprise . Middleware
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to