From d22e52765542ad9df271f3691f3c53853c3a37d6 Mon Sep 17 00:00:00 2001
From: Luke Tomlinson <luketomlinson@github.com>
Date: Fri, 19 Jan 2024 07:51:11 -0800
Subject: [PATCH] cleanup

---
 src/Sdk/DTWebApi/WebApi/BrokerMigrationMessage.cs | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/Sdk/DTWebApi/WebApi/BrokerMigrationMessage.cs b/src/Sdk/DTWebApi/WebApi/BrokerMigrationMessage.cs
index a6f9fffc1..32c08bed5 100644
--- a/src/Sdk/DTWebApi/WebApi/BrokerMigrationMessage.cs
+++ b/src/Sdk/DTWebApi/WebApi/BrokerMigrationMessage.cs
@@ -4,12 +4,15 @@ using System.Runtime.Serialization;
 namespace GitHub.DistributedTask.WebApi
 {
     /// <summary>
-    /// Represents a session for performing message exchanges from an agent.
+    /// Message that tells the runner to redirect itself to BrokerListener for messages.
+    /// (Note that we use a special Message instead of a simple 302. This is because 
+    /// the runner will need to apply the runner's token to the request, and it is
+    /// a security best practice to *not* blindly add sensitive data to redirects
+    /// 302s.)
     /// </summary>
     [DataContract]
     public class BrokerMigrationMessage
     {
-
         public static readonly string MessageType = "BrokerMigration";
 
         public BrokerMigrationMessage()
@@ -23,7 +26,7 @@ namespace GitHub.DistributedTask.WebApi
         }
 
         /// <summary>
-        /// Gets the unique identifier for this session.
+        /// The base url for the broker listener
         /// </summary>
         [DataMember]
         public Uri BrokerBaseUrl