Add description for available responsibles

10 years ago · 708b53c8ad
parent f9e9d0c445
commit 708b53c8ad
1 changed files with 77 additions and 0 deletions
--- a/apiary.apib
+++ b/apiary.apib
@ -1353,6 +1353,83 @@ Gets a list of users that can be assigned to the work package.

    [Available Assignees][]

+## Available Responsibles [/work_packages/{work_package_id}/available_responsibles]
+
+ Model
+    + Body
+    
+            {
+                _total: 1674,
+                _embedded: {
+                  availableResponsibles: [
+                    {
+                        _type: "User",
+                        _links: {
+                            self: {
+                                href: "/api/v3/users/4581",
+                                title: "Mister X"
+                            }
+                        },
+                        id: 4581,
+                        login: "m@x.org",
+                        firstName: "Mister",
+                        lastName: "X",
+                        name: "Mister X",
+                        mail: "m@x.org",
+                        avatar: "http://gravatar.com/avatar/12345678901234567890123456789012",
+                        createdAt: "2013-10-01T16:25:17Z",
+                        updatedAt: "2013-10-02T09:33:42Z"
+                    },
+                    {
+                        _type: "User",
+                        _links: {
+                            self: {
+                                href: "/api/v3/users/972",
+                                title: "Mister Y"
+                            }
+                        },
+                        id: 972,
+                        login: "m@y.org",
+                        firstName: "Mister",
+                        lastName: "Y",
+                        name: "Mister Y",
+                        mail: "m@y.org",
+                        avatar: "http://gravatar.com/avatar/12345678901234567890123456789012",
+                        createdAt: "2013-01-11T11:47:06Z",
+                        updatedAt: "2013-11-18T07:13:56Z"
+                    },
+                    {
+                        _type: "User",
+                            _links: {
+                                self: {
+                                    href: "/api/v3/users/4724",
+                                    title: "Mister Z"
+                                }
+                            },
+                        id: 4724,
+                        login: "m@z.org",
+                        firstName: "Mister",
+                        lastName: "Z",
+                        name: "Mister Z",
+                        mail: "m@z.org",
+                        avatar: "http://gravatar.com/avatar/12345678901234567890123456789012",
+                        createdAt: "2013-10-08T09:28:46Z",
+                        updatedAt: "2013-10-08T09:28:52Z"
+                    }]
+                }
+            }
+
+## Available responsibles [GET]
+
+Gets a list of users that can be assigned to the work package as responsible.
+
+ Parameters
+    + work_package_id (required, integer, `1`) ... Work package id
+
+ Response 200 (application/hal+json)
+
+    [Available Responsibles][]
+
 ## AvailableWatchers [/work_packages/{work_package_id}/available_watchers{?offset,limit,query}]

 + Model