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 { /// - /// 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.) /// [DataContract] public class BrokerMigrationMessage { - public static readonly string MessageType = "BrokerMigration"; public BrokerMigrationMessage() @@ -23,7 +26,7 @@ namespace GitHub.DistributedTask.WebApi } /// - /// Gets the unique identifier for this session. + /// The base url for the broker listener /// [DataMember] public Uri BrokerBaseUrl