From 5338b84f0bb7c0eede0e7b7641a9be9854b68be4 Mon Sep 17 00:00:00 2001
From: Dylan Ratcliffe <dylan@overmind.tech>
Date: Fri, 29 Nov 2024 11:21:51 +0000
Subject: [PATCH] Added more info to the HCP config

---
 changes.proto |  2 +-
 config.proto  | 16 ++++++++++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/changes.proto b/changes.proto
index a7f8b03..0b6603a 100644
--- a/changes.proto
+++ b/changes.proto
@@ -717,7 +717,7 @@ message ChangeProperties {
 
   // Repo information; can be an empty string. CLI attempts auto-population, but users can override. Not necessarily a URL. The UI will be responsible for any formatting/shortnening/sprucing up should it be required.
   string repo = 15;
-  
+
   // User-defined tags associated with this change, will be populated via the CLI and not the UI.
   map<string, string> tags = 16;
 }
diff --git a/config.proto b/config.proto
index 8f4d3a0..e9237f1 100644
--- a/config.proto
+++ b/config.proto
@@ -95,7 +95,12 @@ message CreateHcpConfigRequest {
 }
 
 message CreateHcpConfigResponse {
+    // The configuration of the HCP Run Task that was created
     HcpConfig config = 1;
+
+    // The API Key response for the API key that backs this integration. This
+    // API will have been created but not yet authorised, the user must still be
+    // redirected to the authorizeURL to complete the process.
     apikeys.CreateAPIKeyResponse apiKey = 2;
 }
 
@@ -110,6 +115,17 @@ message GetHcpConfigRequest {}
 
 message GetHcpConfigResponse {
     HcpConfig config = 1;
+
+    enum Status {
+        // The HCP Run Task configuration is active and can be used
+        CONFIGURED = 0;
+        // The HCP Run Task configuration is not fully configured and needs to
+        // be recreated, this is usually due to the API key being revoked or the
+        // user not completing the authorisation process
+        ERROR = 1;
+    }
+
+    Status status = 2;
 }
 
 message DeleteHcpConfigRequest {}