Mailinglist Archive: opensuse-buildservice (247 mails)

< Previous Next >
[opensuse-buildservice] GSoC: Setitng up API calls for OBS Discussion system
Hello,

My mentor and myself have worked on how commenting will work inside
OBS[api] and accordingly [webui] talk to [api]. Below mentioned are
the calls I am plan on setting up. Examples are provided at most of
the areas.



GET /source/<project>/_comments?limit=10&offset=0

Arguments:

project - Project name

Parameter:

limit - Limit the number of retrieved comments

offset - offset received comments by offset

To obtain comments posted for a project

Example:

<comments project=”home:name” size=”2” limit=”10” offset=”0”>

<comment user=”joe” title=”title” id=”0815”>

This is a comment

</comment>

<comment user=”sam” title=”title” id=”0816” parent=”0815”>

This is a reply

</comment>

</comments>

POST /source/<project>/_comments

Arguments:

project - Project name

Creating new comment for a project

GET /source/<project>/<package>/_comments?limit=10&offset=0

Arguments:

project - Project name

package - Package name

Parameter:

limit - Limit the number of retrieved comments

offset - offset received comments by offset

To obtain comments posted for a package in a project

Example:

<comments project=”home:name” package=”foo” size=”2” limit=”10” offset=”0”>

<comment user=”joe” title=”title” id=”0815”>

This is a comment

</comment>

<comment user=”sam” title=”title” id=”0816” parent=”0815”>

This is a reply

</comment>

</comments>

POST /source/<project>/<package>/_comments

Creating new comment for a package

GET /request/<id>/_comments?limit=10&offset=0

Arguments:



id - request id

Parameter:

limit - Limit the number of retrieved comments

offset - offset received comments by offset

To obtain comments posted for a request

Example:

<comments request=”12345” size=”2” limit=”10” offset=”0”>

<comment user=”joe” title=”title” id=”0815”>

This is a comment

</comment>

<comment user=”sam” title=”title” id=”0816” parent=”0815”>

This is a reply

</comment>

</comments>

POST /request/<id>/_comments

Creating new comment for a request

If you have something to add or if you feel something isnt the way it
is suppose to be. Please let me know your thoughts and comments,
and/or if you have any alternative(s) to the same.

Thanks
Shayon
--
To unsubscribe, e-mail: opensuse-buildservice+unsubscribe@xxxxxxxxxxxx
To contact the owner, e-mail: opensuse-buildservice+owner@xxxxxxxxxxxx

< Previous Next >