Use an enum for agent token statuses

Changelog: other

app/graphql/types/clusters/agent_token_status_enum.rb

+# frozen_string_literal: true
+
+module Types
+  module Clusters
+    class AgentTokenStatusEnum < BaseEnum
+      graphql_name 'AgentTokenStatus'
+      description 'Agent token statuses'
+
+      ::Clusters::AgentToken.statuses.keys.each do |status|
+        value status.upcase, value: status, description: "#{status.titleize} agent token."
+      end
+    end
+  end
+end

app/graphql/types/clusters/agent_token_type.rb

@@ -45,7 +45,7 @@ module Types
             description: 'Name given to the token.'
 
       field :status,
-            GraphQL::Types::String,
+            Types::Clusters::AgentTokenStatusEnum,
             null: true,
             description: 'Current status of the token.'
 

doc/api/graphql/reference/index.md

@@ -9029,7 +9029,7 @@ GitLab CI/CD configuration template.
 | <a id="clusteragenttokenid"></a>`id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the token. |
 | <a id="clusteragenttokenlastusedat"></a>`lastUsedAt` | [`Time`](#time) | Timestamp the token was last used. |
 | <a id="clusteragenttokenname"></a>`name` | [`String`](#string) | Name given to the token. |
-| <a id="clusteragenttokenstatus"></a>`status` | [`String`](#string) | Current status of the token. |
+| <a id="clusteragenttokenstatus"></a>`status` | [`AgentTokenStatus`](#agenttokenstatus) | Current status of the token. |
 
 ### `CodeCoverageActivity`
 
@@ -16122,6 +16122,15 @@ Access level to a resource.
 | <a id="accesslevelenumowner"></a>`OWNER` | Owner access. |
 | <a id="accesslevelenumreporter"></a>`REPORTER` | Reporter access. |
 
+### `AgentTokenStatus`
+
+Agent token statuses.
+
+| Value | Description |
+| ----- | ----------- |
+| <a id="agenttokenstatusactive"></a>`ACTIVE` | Active agent token. |
+| <a id="agenttokenstatusrevoked"></a>`REVOKED` | Revoked agent token. |
+
 ### `AlertManagementAlertSort`
 
 Values for sorting alerts.

spec/graphql/types/clusters/agent_token_status_enum_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Types::Clusters::AgentTokenStatusEnum do
+  it { expect(described_class.graphql_name).to eq('AgentTokenStatus') }
+  it { expect(described_class.values.keys).to match_array(Clusters::AgentToken.statuses.keys.map(&:upcase)) }
+end