Commit ccc0fddf authored by Etienne Baqué's avatar Etienne Baqué

Merge branch '340324-runner-status-api-descriptions' into 'master'

Update runner status descriptions

See merge request gitlab-org/gitlab!71447
parents fd079767 471c067f
......@@ -6,8 +6,21 @@ module Types
graphql_name 'CiRunnerStatus'
::Ci::Runner::AVAILABLE_STATUSES.each do |status|
description = case status
when 'active'
"A runner that is not paused."
when 'online'
"A runner that contacted this instance within the last #{::Ci::Runner::ONLINE_CONTACT_TIMEOUT.inspect}."
when 'offline'
"A runner that has not contacted this instance within the last #{::Ci::Runner::ONLINE_CONTACT_TIMEOUT.inspect}."
when 'not_connected'
"A runner that has never contacted this instance."
else
"A runner that is #{status.to_s.tr('_', ' ')}."
end
value status.to_s.upcase,
description: "A runner that is #{status.to_s.tr('_', ' ')}.",
description: description,
value: status.to_sym
end
end
......
......@@ -15382,10 +15382,10 @@ Values for sorting runners.
| Value | Description |
| ----- | ----------- |
| <a id="cirunnerstatusactive"></a>`ACTIVE` | A runner that is active. |
| <a id="cirunnerstatusnot_connected"></a>`NOT_CONNECTED` | A runner that is not connected. |
| <a id="cirunnerstatusoffline"></a>`OFFLINE` | A runner that is offline. |
| <a id="cirunnerstatusonline"></a>`ONLINE` | A runner that is online. |
| <a id="cirunnerstatusactive"></a>`ACTIVE` | A runner that is not paused. |
| <a id="cirunnerstatusnot_connected"></a>`NOT_CONNECTED` | A runner that has never contacted this instance. |
| <a id="cirunnerstatusoffline"></a>`OFFLINE` | A runner that has not contacted this instance within the last 2 hours. |
| <a id="cirunnerstatusonline"></a>`ONLINE` | A runner that contacted this instance within the last 2 hours. |
| <a id="cirunnerstatuspaused"></a>`PAUSED` | A runner that is paused. |
### `CiRunnerType`
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment