Merge pull request #223 from dotnetcore/codex/update-comments-to-english

Clarify parameter documentation throughout services

Author: kklldog

src/AgileConfig.Server.Apisite/AgileConfig.Server.Apisite.xml

@@ -6,16 +6,16 @@ namespace AgileConfig.Server.Apisite
     public class Appsettings
     {
         /// <summary>
-        /// 是否演示模式
+        /// Indicates whether the server runs in demo mode.
         /// </summary>
         public static bool IsPreviewMode => "true".Equals(Global.Config["preview_mode"], StringComparison.CurrentCultureIgnoreCase);
         /// <summary>
-        /// 是否控制台模式
+        /// Indicates whether the admin console mode is enabled.
         /// </summary>
         public static bool IsAdminConsoleMode => "true".Equals(Global.Config["adminConsole"], StringComparison.CurrentCultureIgnoreCase);
 
         /// <summary>
-        /// 是否自动加入节点列表
+        /// Indicates whether the cluster auto-join feature is enabled.
         /// </summary>
         public static bool Cluster => "true".Equals(Global.Config["cluster"], StringComparison.CurrentCultureIgnoreCase);
 
@@ -25,7 +25,7 @@ public class Appsettings
         public static string PathBase => Global.Config["pathBase"];
 
         /// <summary>
-        /// 是否开启SSO
+        /// Indicates whether single sign-on is enabled.
         /// </summary>
         public static bool SsoEnabled => "true".Equals(Global.Config["SSO:enabled"], StringComparison.CurrentCultureIgnoreCase);
 

src/AgileConfig.Server.Apisite/Appsettings.cs

@@ -171,7 +171,7 @@ public IActionResult PasswordInited()
         }
 
         /// <summary>
-        /// 初始化密码
+        /// Initialize the administrator password.
         /// </summary>
         /// <returns></returns>
         [HttpPost]

src/AgileConfig.Server.Apisite/Controllers/AdminController.cs

@@ -294,7 +294,7 @@ public async Task<IActionResult> Delete(string id)
         }
 
         /// <summary>
-        /// 获取所有可以继承的app
+        /// Get all applications that can be inherited.
         /// </summary>
         /// <returns></returns>
         [HttpGet]
@@ -305,7 +305,7 @@ public async Task<IActionResult> InheritancedApps(string currentAppId)
             var self = apps.FirstOrDefault(a => a.Id == currentAppId);
             if (self != null)
             {
-                //过滤本身
+                // Exclude the current application itself.
                 apps.Remove(self);
             }
 
@@ -326,10 +326,10 @@ public async Task<IActionResult> InheritancedApps(string currentAppId)
         }
 
         /// <summary>
-        /// 保存app的授权信息
+        /// Save application authorization information.
         /// </summary>
-        /// <param name="model"></param>
-        /// <returns></returns>
+        /// <param name="model">View model containing authorization assignments.</param>
+        /// <returns>Operation result.</returns>
         [TypeFilter(typeof(PermissionCheckAttribute), Arguments = new object[] { "App.Auth", Functions.App_Auth })]
         [HttpPost]
         public async Task<IActionResult> SaveAppAuth([FromBody] AppAuthVM model)

src/AgileConfig.Server.Apisite/Controllers/AppController.cs

@@ -226,12 +226,12 @@ public async Task<IActionResult> Edit([FromBody] ConfigVM model, [FromQuery] Env
                 var isPublished = await _configService.IsPublishedAsync(config.Id, env.Value);
                 if (isPublished)
                 {
-                    //如果是已发布的配置，修改后状态设置为编辑
+                    // When an already published configuration is modified, mark it as edited.
                     config.EditStatus = EditStatus.Edit;
                 }
                 else
                 {
-                    //如果没有发布，说明是新增的，一直维持新增状态
+                    // If it has never been published, keep the status as added.
                     config.EditStatus = EditStatus.Add;
                 }
 
@@ -253,11 +253,11 @@ public async Task<IActionResult> Edit([FromBody] ConfigVM model, [FromQuery] Env
         }
 
         /// <summary>
-        /// 是否只是修改了描述信息
+        /// Determine whether only the description field changed.
         /// </summary>
-        /// <param name="newConfig"></param>
-        /// <param name="oldConfig"></param>
-        /// <returns></returns>
+        /// <param name="newConfig">Configuration submitted by the client.</param>
+        /// <param name="oldConfig">Existing configuration stored in the database.</param>
+        /// <returns>True when only the description differs.</returns>
         private bool IsOnlyUpdateDescription(Config newConfig, Config oldConfig)
         {
             return newConfig.Key == oldConfig.Key && newConfig.Group == oldConfig.Group &&
@@ -279,14 +279,14 @@ public async Task<IActionResult> All(string env)
         }
 
         /// <summary>
-        /// 按多条件进行搜索
+        /// Search configurations with multiple filter conditions.
         /// </summary>
-        /// <param name="appId">应用id</param>
-        /// <param name="group">分组</param>
-        /// <param name="key">键</param>
-        /// <param name="onlineStatus">在线状态</param>
-        /// <param name="pageSize">分页大小</param>
-        /// <param name="current">当前页</param>
+        /// <param name="appId">Application ID.</param>
+        /// <param name="group">Configuration group.</param>
+        /// <param name="key">Configuration key.</param>
+        /// <param name="onlineStatus">Filter by online status.</param>
+        /// <param name="pageSize">Number of items per page.</param>
+        /// <param name="current">Current page number.</param>
         /// <returns></returns>
         [HttpGet]
         public async Task<IActionResult> Search(string appId, string group, string key, OnlineStatus? onlineStatus,
@@ -390,7 +390,7 @@ public async Task<IActionResult> Delete(string id, EnvString env)
             var isPublished = await _configService.IsPublishedAsync(config.Id, env.Value);
             if (!isPublished)
             {
-                //如果已经没有发布过直接删掉
+                // If it has never been published, remove it directly.
                 config.Status = ConfigStatus.Deleted;
             }
 
@@ -437,7 +437,7 @@ public async Task<IActionResult> DeleteSome([FromBody] List<string> ids, EnvStri
                 var isPublished = await _configService.IsPublishedAsync(config.Id, env.Value);
                 if (!isPublished)
                 {
-                    //如果已经没有发布过直接删掉
+                    // If it has never been published, remove it directly.
                     config.Status = ConfigStatus.Deleted;
                 }
 
@@ -514,7 +514,7 @@ public async Task<IActionResult> ConfigPublishedHistory(string configId, EnvStri
         }
 
         /// <summary>
-        /// 发布所有待发布的配置项
+        /// Publish all pending configuration items.
         /// </summary>
         /// <returns></returns>
         [TypeFilter(typeof(PermissionCheckAttribute),
@@ -550,7 +550,7 @@ public async Task<IActionResult> Publish([FromBody] PublishLogVM model, EnvStrin
         }
 
         /// <summary>
-        /// 预览上传的json文件
+        /// Preview an uploaded JSON configuration file.
         /// </summary>
         /// <returns></returns>
         public IActionResult PreViewJsonFile()
@@ -578,7 +578,7 @@ public IActionResult PreViewJsonFile()
                     var paths = key.Split(":");
                     if (paths.Length > 1)
                     {
-                        //如果是复杂key，取最后一个为真正的key，其他作为group
+                        // For hierarchical keys, use the last segment as the key and the rest as the group.
                         newKey = paths[paths.Length - 1];
                         group = string.Join(":", paths.ToList().Take(paths.Length - 1));
                     }
@@ -601,9 +601,9 @@ public IActionResult PreViewJsonFile()
         }
 
         /// <summary>
-        /// 导出json文件
+        /// Export an application's configurations as a JSON file.
         /// </summary>
-        /// <param name="appId">应用id</param>
+        /// <param name="appId">Application ID.</param>
         /// <returns></returns>
         public async Task<IActionResult> ExportJson(string appId, EnvString env)
         {
@@ -627,9 +627,9 @@ public async Task<IActionResult> ExportJson(string appId, EnvString env)
         }
 
         /// <summary>
-        /// 获取待发布的明细
+        /// Get counts of configuration changes that are waiting to be published.
         /// </summary>
-        /// <param name="appId">应用id</param>
+        /// <param name="appId">Application ID.</param>
         /// <returns></returns>
         public async Task<IActionResult> WaitPublishStatus(string appId, EnvString env)
         {
@@ -659,9 +659,9 @@ public async Task<IActionResult> WaitPublishStatus(string appId, EnvString env)
         }
 
         /// <summary>
-        /// 获取发布详情的历史
+        /// Retrieve the publish history details for an application.
         /// </summary>
-        /// <param name="appId"></param>
+        /// <param name="appId">Application ID.</param>
         /// <returns></returns>
         public async Task<IActionResult> PublishHistory(string appId, EnvString env)
         {
@@ -781,7 +781,7 @@ public async Task<IActionResult> GetKvList(string appId, EnvString env)
             }
 
             var configs = await _configService.GetByAppIdAsync(appId, env.Value);
-            // text 格式展示的时候不需要删除的配置
+            // When displaying text format, exclude deleted configurations.
             configs = configs.Where(x => x.EditStatus != EditStatus.Deleted).ToList();
             var kvList = new List<KeyValuePair<string, string>>();
             foreach (var config in configs)
@@ -798,9 +798,9 @@ public async Task<IActionResult> GetKvList(string appId, EnvString env)
         }
 
         /// <summary>
-        /// 获取json格式的配置
+        /// Get configuration content in JSON format.
         /// </summary>
-        /// <param name="appId">应用id</param>
+        /// <param name="appId">Application ID.</param>
         /// <returns></returns>
         public async Task<IActionResult> GetJson(string appId, EnvString env)
         {
@@ -810,7 +810,7 @@ public async Task<IActionResult> GetJson(string appId, EnvString env)
             }
 
             var configs = await _configService.GetByAppIdAsync(appId, env.Value);
-            // json 格式展示的时候不需要删除的配置
+            // When producing JSON, exclude deleted configurations.
             configs = configs.Where(x => x.EditStatus != EditStatus.Deleted).ToList();
             var dict = new Dictionary<string, string>();
             configs.ForEach(x =>

src/AgileConfig.Server.Apisite/Controllers/ConfigController.cs

@@ -9,7 +9,7 @@
 namespace AgileConfig.Server.Apisite.Controllers
 {
     /// <summary>
-    /// 这个Controller用来接受其它节点发送过来的命令
+    /// Receives commands sent from other nodes.
     /// </summary>
     public class RemoteOpController : Controller
     {

src/AgileConfig.Server.Apisite/Controllers/RemoteOPController.cs

@@ -14,7 +14,7 @@
 namespace AgileConfig.Server.Apisite.Controllers
 {
     /// <summary>
-    /// 这个Controller是控制台网页跟后台的接口，不要跟RemoteOp那个Controller混淆
+    /// Handles console web requests that proxy operations to remote server nodes (distinct from RemoteOpController).
     /// </summary>
     [Authorize]
     public class RemoteServerProxyController : Controller
@@ -35,11 +35,11 @@ ITinyEventBus tinyEventBus
         }
 
         /// <summary>
-        /// 通知一个节点的某个客户端离线
+        /// Notify a node to disconnect a specific client.
         /// </summary>
-        /// <param name="address"></param>
-        /// <param name="clientId"></param>
-        /// <returns></returns>
+        /// <param name="address">Remote node address.</param>
+        /// <param name="clientId">Client identifier to disconnect.</param>
+        /// <returns>Operation result.</returns>
         [HttpPost]
         public async Task<IActionResult> Client_Offline(string address, string clientId)
         {
@@ -69,10 +69,10 @@ public async Task<IActionResult> Client_Offline(string address, string clientId)
         }
 
         /// <summary>
-        /// 通知某个节点让所有的客户端刷新配置项
+        /// Notify a node to instruct all clients to reload configuration.
         /// </summary>
-        /// <param name="address"></param>
-        /// <returns></returns>
+        /// <param name="address">Remote node address.</param>
+        /// <returns>Operation result.</returns>
         [HttpPost]
         public async Task<IActionResult> AllClients_Reload(string address)
         {
@@ -89,11 +89,11 @@ public async Task<IActionResult> AllClients_Reload(string address)
         }
 
         /// <summary>
-        /// 通知某个节点个某个客户端刷新配置项
+        /// Notify a node to instruct a single client to reload configuration.
         /// </summary>
-        /// <param name="address"></param>
-        /// <param name="clientId"></param>
-        /// <returns></returns>
+        /// <param name="address">Remote node address.</param>
+        /// <param name="clientId">Client identifier to reload.</param>
+        /// <returns>Operation result.</returns>
         [HttpPost]
         public async Task<IActionResult> Client_Reload(string address, string clientId)
         {