diff --git a/apiary.apib b/apiary.apib index 202b44cf10..f9635a165e 100644 --- a/apiary.apib +++ b/apiary.apib @@ -188,15 +188,15 @@ Activity can be either _type Activity or _type Activity::Comment. "_type": "Activity::Comment", "_links": { "self": { - "href": "https://openproject.org/api/v3/activity/1", + "href": "/api/v3/activity/1", "title": "Priority changed from High to Low" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -259,15 +259,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Attachment", "_links": { "self": { - "href": "https://openproject.org/api/v3/attachments/1", + "href": "/api/v3/attachments/1", "title": "dolor_sit_amet" }, "workPackage" { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "Lorem ipsum" }, "author": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -315,11 +315,11 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Project", "_links": { "self": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem" }, "workPackages": [{ - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "Lorem ipsum" }] }, @@ -372,15 +372,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Query", "_links": { "self": { - "href": "https://openproject.org/api/v3/queries/2", + "href": "/api/v3/queries/2", "title": "My work packages" }, "project": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem ipsum" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -439,15 +439,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Query", "_links": { "self": { - "href": "https://openproject.org/api/v3/queries/2", + "href": "/api/v3/queries/2", "title": "My work packages" }, "project": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem ipsum" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -506,15 +506,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Query", "_links": { "self": { - "href": "https://openproject.org/api/v3/queries/2", + "href": "/api/v3/queries/2", "title": "My work packages" }, "project": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem ipsum" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -588,7 +588,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -622,7 +622,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -688,39 +688,39 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "WorkPackage", "_links": { "self": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "author": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "responsible": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "assignee": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "project": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem" }, "activities": [{ - "href": "https://openproject.org/api/v3/activities/1", + "href": "/api/v3/activities/1", "title": "Priority changed from High to Low" }], "watchers": [{ - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }], "relations": [{ - "href": "https://openproject.org/api/v3/relationships/1", + "href": "/api/v3/relationships/1", "title": "Work package A duplicated by Work package B" }], "attachments": [{ - "href": "https://openproject.org/api/v3/attachments/1", + "href": "/api/v3/attachments/1", "title": "Attachment filename" }] }, @@ -729,7 +729,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -746,7 +746,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -763,7 +763,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -780,11 +780,11 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Project", "_links": { "self": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem" }, "workPackages": [{ - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "Lorem ipsum" }] }, @@ -808,15 +808,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Activity::Comment", "_links": { "self": { - "href": "https://openproject.org/api/v3/activities/1", + "href": "/api/v3/activities/1", "title": "Priority changed from High to Low" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -834,11 +834,11 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "unwatch": { - "href": "https://openproject.org/api/v3/work_packages/1/watchers/1", + "href": "/api/v3/work_packages/1/watchers/1", "method": "delete", "title": "Unwatch work package" } @@ -858,15 +858,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Relationship", "_links": { "self": { - "href": "https://openproject.org/api/v3/relationships/1", + "href": "/api/v3/relationships/1", "title": "Work package A duplicated by Work package B" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "relatedWorkPackage": { - "href": "https://openproject.org/api/v3/work_packages/2", + "href": "/api/v3/work_packages/2", "title": "Lorem ipsum" } }, @@ -884,15 +884,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Attachment", "_links": { "self": { - "href": "https://openproject.org/api/v3/attachments/1", + "href": "/api/v3/attachments/1", "title": "Attachment filename" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "author": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "Users login" } }, @@ -950,59 +950,59 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "WorkPackage", "_links": { "self": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "author": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "responsible": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "assignee": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }, "project": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem" }, "activities": [{ - "href": "https://openproject.org/api/v3/activities/1", + "href": "/api/v3/activities/1", "title": "Priority changed from High to Low" }], "watchers": [{ - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" }], "addWatcher": [{ - "href": "https://openproject.org/api/v3/work_packages/1/watchers, + "href": "/api/v3/work_packages/1/watchers, "title": "John Sheppard" }], "removeWatcher": [{ - "href": "https://openproject.org/api/v3/work_packages/1/watchters{/id}", + "href": "/api/v3/work_packages/1/watchters{/id}", "title": "John Sheppard", "templated": true }], "watch": { - "href": "https://openproject.org/api/v3/work_packages/1/watchers", + "href": "/api/v3/work_packages/1/watchers", "method": "post", "data": "{ "user_id": 1 }", "title": "Watch work package" }, "unwatch": { - "href": "https://openproject.org/api/v3/work_packages/1/watchers/1", + "href": "/api/v3/work_packages/1/watchers/1", "method": "delete", "title": "Unwatch work package" }, "relations": [{ - "href": "https://openproject.org/api/v3/relationships/1", + "href": "/api/v3/relationships/1", "title": "Work package A duplicated by Work package B" }], "attachments": [{ - "href": "https://openproject.org/api/v3/attachments/1", + "href": "/api/v3/attachments/1", "title": "Attachment filename" }] }, @@ -1011,7 +1011,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -1028,7 +1028,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -1045,7 +1045,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -1062,11 +1062,11 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Project", "_links": { "self": { - "href": "https://openproject.org/api/v3/projects/1", + "href": "/api/v3/projects/1", "title": "Lorem" }, "workPackages": [{ - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "Lorem ipsum" }] }, @@ -1090,15 +1090,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Activity::Comment", "_links": { "self": { - "href": "https://openproject.org/api/v3/activities/1", + "href": "/api/v3/activities/1", "title": "Priority changed from High to Low" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "user": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - admin" } }, @@ -1116,7 +1116,7 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "User", "_links": { "self": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "John Sheppard - j.sheppard" } }, @@ -1135,15 +1135,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Relationship", "_links": { "self": { - "href": "https://openproject.org/api/v3/relationships/1", + "href": "/api/v3/relationships/1", "title": "Work package A duplicated by Work package B" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "relatedWorkPackage": { - "href": "https://openproject.org/api/v3/work_packages/2", + "href": "/api/v3/work_packages/2", "title": "Lorem ipsum" } }, @@ -1161,15 +1161,15 @@ A user must have the permission to **edit journals** to update an activity. A "_type": "Attachment", "_links": { "self": { - "href": "https://openproject.org/api/v3/attachments/1", + "href": "/api/v3/attachments/1", "title": "Attachment filename" }, "workPackage": { - "href": "https://openproject.org/api/v3/work_packages/1", + "href": "/api/v3/work_packages/1", "title": "quis numquam qui voluptatum quia praesentium blanditiis nisi" }, "author": { - "href": "https://openproject.org/api/v3/users/1", + "href": "/api/v3/users/1", "title": "Users login" } },