[Fedora QA] #392: ReSTful API

[Fedora QA]

#392: ReSTful API
--------------------------------------+-------------------------
 Reporter:  islamgulov                |       Owner:  islamgulov
     Type:  enhancement               |      Status:  new
 Priority:  major                     |   Milestone:  Fedora 20
Component:  Blocker bug tracker page  |     Version:
 Keywords:                            |  Blocked By:
 Blocking:                            |
--------------------------------------+-------------------------
 = problem =
 At the moment, Blocker bug tracker app has not API.
 = analysis =
 API is defined as RESTful HTTP service.
 API support JSON data serialization request and response formats.
 `application/json` in the Content-Type header required in the request.
 Time is specified as an ISO 8601 dateTime (2011-01-24T17:08Z).
 List operations return all items at a time (no paging).

 Endpoints:
 1) Lists bugs associated with a milestone.
  GET /api/v<api version>/miletstone/<rel_num>/<version>/bug?type=type&
 To filter the list of bugs, you can specify the following optional URI
 parameters:
  - type=type& - Filters the list of bugs by type.

 List bugs response fields:
  - bzid: Bugzilla bug id
  - url
  - summary
  - status
  - component
  - active
  - type

 Possible values for the bug type attribute include: 'proposed_blocker',
 'proposed_fe', 'accepted_blocker', 'accepted_fe', 'rejected_blocker',
 'rejected_fe'.

 2) Lists updates associated with a milestone.
 GET /api/v<api
 version>/miletstone/<rel_num>/<version>/update?bugtype=bugtype&
 Parameters:
  - bugtype=bugtype& - Filters the list of update by type of bugs.

 List updates response fields:
 - title
 - url
 - karma
 - stable_karma
 - status
 - pending
 - bugs:
  - bzid
  - type
 - release
 - milestones:
  - version

 3) Lists spins associated with a milestone.
 GET /api/v<api version>/miletstone/<rel_num>/<version>/spin/

 List spins response fields:
  - id
  - name
  - state
  - url
  - date_requested
  - date_created
  - spin_type
  - updates:
   - title
   - status
   - url
  - succeeds:
   - id
  - milestone

-- 
Ticket URL: <https://fedorahosted.org/fedora-qa/ticket/392>
Fedora QA <http://fedorahosted.org/fedora-qa>
Fedora Quality Assurance