From 5e0143a84bca7fd8b2dccd175e0f50c87dea4b98 Mon Sep 17 00:00:00 2001 From: Alessio Caiazza Date: Sat, 27 May 2017 15:23:27 +0200 Subject: [PATCH 1/2] Add online attribute to runner api entity --- .../unreleased/feature-api_runners_online.yml | 4 +++ doc/api/runners.md | 29 +++++++++++++------ lib/api/entities.rb | 1 + 3 files changed, 25 insertions(+), 9 deletions(-) create mode 100644 changelogs/unreleased/feature-api_runners_online.yml diff --git a/changelogs/unreleased/feature-api_runners_online.yml b/changelogs/unreleased/feature-api_runners_online.yml new file mode 100644 index 00000000000..f5077507e5b --- /dev/null +++ b/changelogs/unreleased/feature-api_runners_online.yml @@ -0,0 +1,4 @@ +--- +title: Add online attribute to runner api entity +merge_request: 11750 +author: Alessio Caiazza diff --git a/doc/api/runners.md b/doc/api/runners.md index 015b09a745e..50981ed96bc 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -30,14 +30,16 @@ Example response: "description": "test-1-20150125", "id": 6, "is_shared": false, - "name": null + "name": null, + "online": true }, { "active": true, "description": "test-2-20150125", "id": 8, "is_shared": false, - "name": null + "name": null, + "online": false } ] ``` @@ -69,28 +71,32 @@ Example response: "description": "shared-runner-1", "id": 1, "is_shared": true, - "name": null + "name": null, + "online": true }, { "active": true, "description": "shared-runner-2", "id": 3, "is_shared": true, - "name": null + "name": null, + "online": false }, { "active": true, "description": "test-1-20150125", "id": 6, "is_shared": false, - "name": null + "name": null, + "online": true }, { "active": true, "description": "test-2-20150125", "id": 8, "is_shared": false, - "name": null + "name": null, + "online": false } ] ``` @@ -122,6 +128,7 @@ Example response: "is_shared": false, "contacted_at": "2016-01-25T16:39:48.066Z", "name": null, + "online": true, "platform": null, "projects": [ { @@ -176,6 +183,7 @@ Example response: "is_shared": false, "contacted_at": "2016-01-25T16:39:48.066Z", "name": null, + "online": true, "platform": null, "projects": [ { @@ -327,14 +335,16 @@ Example response: "description": "test-2-20150125", "id": 8, "is_shared": false, - "name": null + "name": null, + "online": false }, { "active": true, "description": "development_runner", "id": 5, "is_shared": true, - "name": null + "name": null, + "online": true } ] ``` @@ -364,7 +374,8 @@ Example response: "description": "test-2016-02-01", "id": 9, "is_shared": false, - "name": null + "name": null, + "online": true } ``` diff --git a/lib/api/entities.rb b/lib/api/entities.rb index 4ad4a1f7867..c612dde7f73 100644 --- a/lib/api/entities.rb +++ b/lib/api/entities.rb @@ -862,6 +862,7 @@ module API expose :active expose :is_shared expose :name + expose :online?, as: :online end class RunnerDetails < Runner From 3514b7248cf00bcee8a6b3133e4e157f656d30c6 Mon Sep 17 00:00:00 2001 From: Alessio Caiazza Date: Tue, 13 Jun 2017 22:03:34 +0200 Subject: [PATCH 2/2] Add status attribute to runner api entity --- .../unreleased/feature-api_runners_online.yml | 5 ++-- doc/api/runners.md | 23 ++++++++++++++----- lib/api/entities.rb | 1 + 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/changelogs/unreleased/feature-api_runners_online.yml b/changelogs/unreleased/feature-api_runners_online.yml index f5077507e5b..08f4dd16f28 100644 --- a/changelogs/unreleased/feature-api_runners_online.yml +++ b/changelogs/unreleased/feature-api_runners_online.yml @@ -1,4 +1,5 @@ --- -title: Add online attribute to runner api entity +title: Add online and status attribute to runner api entity merge_request: 11750 -author: Alessio Caiazza +author: +type: added diff --git a/doc/api/runners.md b/doc/api/runners.md index 50981ed96bc..7495c6cdedb 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -31,7 +31,8 @@ Example response: "id": 6, "is_shared": false, "name": null, - "online": true + "online": true, + "status": "online" }, { "active": true, @@ -39,7 +40,8 @@ Example response: "id": 8, "is_shared": false, "name": null, - "online": false + "online": false, + "status": "offline" } ] ``` @@ -72,7 +74,8 @@ Example response: "id": 1, "is_shared": true, "name": null, - "online": true + "online": true, + "status": "online" }, { "active": true, @@ -81,6 +84,7 @@ Example response: "is_shared": true, "name": null, "online": false + "status": "offline" }, { "active": true, @@ -89,6 +93,7 @@ Example response: "is_shared": false, "name": null, "online": true + "status": "paused" }, { "active": true, @@ -96,7 +101,8 @@ Example response: "id": 8, "is_shared": false, "name": null, - "online": false + "online": false, + "status": "offline" } ] ``` @@ -129,6 +135,7 @@ Example response: "contacted_at": "2016-01-25T16:39:48.066Z", "name": null, "online": true, + "status": "online", "platform": null, "projects": [ { @@ -184,6 +191,7 @@ Example response: "contacted_at": "2016-01-25T16:39:48.066Z", "name": null, "online": true, + "status": "online", "platform": null, "projects": [ { @@ -336,7 +344,8 @@ Example response: "id": 8, "is_shared": false, "name": null, - "online": false + "online": false, + "status": "offline" }, { "active": true, @@ -345,6 +354,7 @@ Example response: "is_shared": true, "name": null, "online": true + "status": "paused" } ] ``` @@ -375,7 +385,8 @@ Example response: "id": 9, "is_shared": false, "name": null, - "online": true + "online": true, + "status": "online" } ``` diff --git a/lib/api/entities.rb b/lib/api/entities.rb index c612dde7f73..f5fa5fef389 100644 --- a/lib/api/entities.rb +++ b/lib/api/entities.rb @@ -863,6 +863,7 @@ module API expose :is_shared expose :name expose :online?, as: :online + expose :status end class RunnerDetails < Runner