补充注释

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingAuditController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职审核相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职审核")]
 [Route("biz/onboarding/audit")]
 [RolePermission]
@@ -12,15 +15,21 @@ public class OnboardingAuditController
         _service = service;
     }
 
+    /// <summary>
+    /// 审核通过任务并创建正式员工档案。
+    /// </summary>
     [HttpPost("approve")]
     public async Task Approve([FromBody] OnboardingAuditActionInput input)
     {
         await _service.Approve(input);
     }
 
+    /// <summary>
+    /// 退回任务并要求候选人补充资料。
+    /// </summary>
     [HttpPost("reject")]
     public async Task Reject([FromBody] OnboardingAuditActionInput input)
     {
         await _service.Reject(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingCompanyController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职业务公司相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职公司管理")]
 [Route("biz/onboarding/company")]
 [RolePermission]
@@ -12,39 +15,57 @@ public class OnboardingCompanyController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询入职业务公司。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingCompanyPageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询已启用公司列表。
+    /// </summary>
     [HttpGet("list-enabled")]
     public async Task<dynamic> ListEnabled()
     {
         return await _service.ListEnabled();
     }
 
+    /// <summary>
+    /// 查询公司详情。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
 
+    /// <summary>
+    /// 新增入职业务公司。
+    /// </summary>
     [HttpPost("add")]
     public async Task Add([FromBody] OnboardingCompanyAddInput input)
     {
         await _service.Add(input);
     }
 
+    /// <summary>
+    /// 编辑入职业务公司。
+    /// </summary>
     [HttpPost("edit")]
     public async Task Edit([FromBody] OnboardingCompanyEditInput input)
     {
         await _service.Edit(input);
     }
 
+    /// <summary>
+    /// 删除入职业务公司。
+    /// </summary>
     [HttpPost("delete")]
     public async Task Delete([FromBody] BaseIdListInput input)
     {
         await _service.Delete(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingContractDocumentController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职合同文件生成相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职合同文件")]
 [Route("biz/onboarding/contract-document")]
 [RolePermission]
@@ -22,4 +25,4 @@ public class OnboardingContractDocumentController
     {
         return await _service.Generate(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingContractTemplateController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供合同模板、版本、变量和适用范围相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职合同模板")]
 [Route("biz/onboarding/contract-template")]
 [RolePermission]
@@ -12,99 +15,147 @@ public class OnboardingContractTemplateController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询合同模板。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingContractTemplatePageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询合同模板详情。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
 
+    /// <summary>
+    /// 新增合同模板。
+    /// </summary>
     [HttpPost("add")]
     public async Task Add([FromBody] OnboardingContractTemplateAddInput input)
     {
         await _service.Add(input);
     }
 
+    /// <summary>
+    /// 编辑合同模板。
+    /// </summary>
     [HttpPost("edit")]
     public async Task Edit([FromBody] OnboardingContractTemplateEditInput input)
     {
         await _service.Edit(input);
     }
 
+    /// <summary>
+    /// 删除合同模板。
+    /// </summary>
     [HttpPost("delete")]
     public async Task Delete([FromBody] BaseIdListInput input)
     {
         await _service.Delete(input);
     }
 
+    /// <summary>
+    /// 分页查询合同模板版本。
+    /// </summary>
     [HttpGet("version/page")]
     public async Task<dynamic> VersionPage([FromQuery] OnboardingContractVersionPageInput input)
     {
         return await _service.VersionPage(input);
     }
 
+    /// <summary>
+    /// 新增合同模板版本。
+    /// </summary>
     [HttpPost("version/add")]
     public async Task AddVersion([FromBody] OnboardingContractVersionAddInput input)
     {
         await _service.AddVersion(input);
     }
 
+    /// <summary>
+    /// 设置合同模板版本状态。
+    /// </summary>
     [HttpPost("version/set-status")]
     public async Task SetVersionStatus([FromBody] OnboardingContractVersionStatusInput input)
     {
         await _service.SetVersionStatus(input);
     }
 
+    /// <summary>
+    /// 分页查询模板变量。
+    /// </summary>
     [HttpGet("variable/page")]
     public async Task<dynamic> VariablePage([FromQuery] OnboardingTemplateVariablePageInput input)
     {
         return await _service.VariablePage(input);
     }
 
+    /// <summary>
+    /// 新增模板变量。
+    /// </summary>
     [HttpPost("variable/add")]
     public async Task AddVariable([FromBody] OnboardingTemplateVariableAddInput input)
     {
         await _service.AddVariable(input);
     }
 
+    /// <summary>
+    /// 编辑模板变量。
+    /// </summary>
     [HttpPost("variable/edit")]
     public async Task EditVariable([FromBody] OnboardingTemplateVariableEditInput input)
     {
         await _service.EditVariable(input);
     }
 
+    /// <summary>
+    /// 删除模板变量。
+    /// </summary>
     [HttpPost("variable/delete")]
     public async Task DeleteVariable([FromBody] BaseIdListInput input)
     {
         await _service.DeleteVariable(input);
     }
 
+    /// <summary>
+    /// 分页查询合同适用范围。
+    /// </summary>
     [HttpGet("scope/page")]
     public async Task<dynamic> ScopePage([FromQuery] OnboardingContractScopePageInput input)
     {
         return await _service.ScopePage(input);
     }
 
+    /// <summary>
+    /// 新增合同适用范围。
+    /// </summary>
     [HttpPost("scope/add")]
     public async Task AddScope([FromBody] OnboardingContractScopeAddInput input)
     {
         await _service.AddScope(input);
     }
 
+    /// <summary>
+    /// 编辑合同适用范围。
+    /// </summary>
     [HttpPost("scope/edit")]
     public async Task EditScope([FromBody] OnboardingContractScopeEditInput input)
     {
         await _service.EditScope(input);
     }
 
+    /// <summary>
+    /// 删除合同适用范围。
+    /// </summary>
     [HttpPost("scope/delete")]
     public async Task DeleteScope([FromBody] BaseIdListInput input)
     {
         await _service.DeleteScope(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingEmployeeController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供正式员工档案相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职正式员工档案")]
 [Route("biz/onboarding/employee")]
 [RolePermission]
@@ -12,15 +15,21 @@ public class OnboardingEmployeeController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询正式员工档案。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingEmployeePageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询正式员工详情及来源记录。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingEntryConfigController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职字段与材料要求配置相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职填写与材料配置")]
 [Route("biz/onboarding/entry-config")]
 [RolePermission]
@@ -12,75 +15,111 @@ public class OnboardingEntryConfigController
         _service = service;
     }
 
+    /// <summary>
+    /// 查询动态入职字段。
+    /// </summary>
     [HttpGet("form-field/list")]
     public async Task<dynamic> ListFormFields()
     {
         return await _service.ListFormFields();
     }
 
+    /// <summary>
+    /// 保存动态入职字段。
+    /// </summary>
     [HttpPost("form-field/save")]
     public async Task SaveFormField([FromBody] OnboardingFormFieldSaveInput input)
     {
         await _service.SaveFormField(input);
     }
 
+    /// <summary>
+    /// 删除动态入职字段。
+    /// </summary>
     [HttpPost("form-field/delete")]
     public async Task DeleteFormFields([FromBody] BaseIdListInput input)
     {
         await _service.DeleteFormFields(input);
     }
 
+    /// <summary>
+    /// 查询入职材料类型。
+    /// </summary>
     [HttpGet("material-type/list")]
     public async Task<dynamic> ListMaterialTypes()
     {
         return await _service.ListMaterialTypes();
     }
 
+    /// <summary>
+    /// 保存入职材料类型。
+    /// </summary>
     [HttpPost("material-type/save")]
     public async Task SaveMaterialType([FromBody] OnboardingMaterialTypeSaveInput input)
     {
         await _service.SaveMaterialType(input);
     }
 
+    /// <summary>
+    /// 删除入职材料类型。
+    /// </summary>
     [HttpPost("material-type/delete")]
     public async Task DeleteMaterialTypes([FromBody] BaseIdListInput input)
     {
         await _service.DeleteMaterialTypes(input);
     }
 
+    /// <summary>
+    /// 查询公司岗位动态字段要求。
+    /// </summary>
     [HttpGet("form-requirement/list")]
     public async Task<dynamic> ListFormRequirements([FromQuery] long companyId)
     {
         return await _service.ListFormRequirements(companyId);
     }
 
+    /// <summary>
+    /// 保存公司岗位动态字段要求。
+    /// </summary>
     [HttpPost("form-requirement/save")]
     public async Task SaveFormRequirement([FromBody] OnboardingFormRequirementSaveInput input)
     {
         await _service.SaveFormRequirement(input);
     }
 
+    /// <summary>
+    /// 删除动态字段要求。
+    /// </summary>
     [HttpPost("form-requirement/delete")]
     public async Task DeleteFormRequirements([FromBody] BaseIdListInput input)
     {
         await _service.DeleteFormRequirements(input);
     }
 
+    /// <summary>
+    /// 查询公司岗位材料要求。
+    /// </summary>
     [HttpGet("material-requirement/list")]
     public async Task<dynamic> ListMaterialRequirements([FromQuery] long companyId)
     {
         return await _service.ListMaterialRequirements(companyId);
     }
 
+    /// <summary>
+    /// 保存公司岗位材料要求。
+    /// </summary>
     [HttpPost("material-requirement/save")]
     public async Task SaveMaterialRequirement([FromBody] OnboardingMaterialRequirementSaveInput input)
     {
         await _service.SaveMaterialRequirement(input);
     }
 
+    /// <summary>
+    /// 删除材料要求。
+    /// </summary>
     [HttpPost("material-requirement/delete")]
     public async Task DeleteMaterialRequirements([FromBody] BaseIdListInput input)
     {
         await _service.DeleteMaterialRequirements(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingMaterialReviewController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供候选人材料审核相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职资料审核")]
 [Route("biz/onboarding/material")]
 [RolePermission]
@@ -12,9 +15,12 @@ public class OnboardingMaterialReviewController
         _service = service;
     }
 
+    /// <summary>
+    /// 审核候选人上传的材料。
+    /// </summary>
     [HttpPost("review")]
     public async Task Review([FromBody] OnboardingMaterialReviewInput input)
     {
         await _service.Review(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingPositionController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职业务岗位相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职岗位管理")]
 [Route("biz/onboarding/position")]
 [RolePermission]
@@ -12,39 +15,57 @@ public class OnboardingPositionController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询入职业务岗位。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingPositionPageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询指定公司的已启用岗位。
+    /// </summary>
     [HttpGet("list-enabled")]
     public async Task<dynamic> ListEnabled([FromQuery] long companyId)
     {
         return await _service.ListEnabled(companyId);
     }
 
+    /// <summary>
+    /// 查询岗位详情。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
 
+    /// <summary>
+    /// 新增入职业务岗位。
+    /// </summary>
     [HttpPost("add")]
     public async Task Add([FromBody] OnboardingPositionAddInput input)
     {
         await _service.Add(input);
     }
 
+    /// <summary>
+    /// 编辑入职业务岗位。
+    /// </summary>
     [HttpPost("edit")]
     public async Task Edit([FromBody] OnboardingPositionEditInput input)
     {
         await _service.Edit(input);
     }
 
+    /// <summary>
+    /// 删除入职业务岗位。
+    /// </summary>
     [HttpPost("delete")]
     public async Task Delete([FromBody] BaseIdListInput input)
     {
         await _service.Delete(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingPublicSubmissionController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供员工端资料提交相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "员工入职提交")]
 [Route("open/onboarding")]
 [AllowAnonymous]
@@ -14,30 +17,45 @@ public class OnboardingPublicSubmissionController
         _fileService = fileService;
     }
 
+    /// <summary>
+    /// 保存员工动态字段。
+    /// </summary>
     [HttpPost("save-dynamic-values")]
     public async Task SaveDynamicValues([FromBody] OnboardingSaveDynamicValuesInput input)
     {
         await _service.SaveDynamicValues(input);
     }
 
+    /// <summary>
+    /// 保存员工已上传材料记录。
+    /// </summary>
     [HttpPost("save-material")]
     public async Task SaveMaterial([FromBody] OnboardingSaveMaterialInput input)
     {
         await _service.SaveMaterial(input);
     }
 
+    /// <summary>
+    /// 确认已阅读指定合同。
+    /// </summary>
     [HttpPost("confirm-contract")]
     public async Task ConfirmContract([FromBody] OnboardingConfirmContractInput input)
     {
         await _service.ConfirmContract(input);
     }
 
+    /// <summary>
+    /// 提交入职资料进入审核。
+    /// </summary>
     [HttpPost("submit")]
     public async Task Submit([FromBody] OnboardingSubmitInput input)
     {
         await _service.Submit(input);
     }
 
+    /// <summary>
+    /// 校验并上传员工入职材料。
+    /// </summary>
     [HttpPost("upload-material")]
     [Consumes("multipart/form-data")]
     [RequestSizeLimit(20 * 1024 * 1024)]
@@ -64,4 +82,4 @@ public class OnboardingPublicSubmissionController
             FileId = fileId
         });
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingPublicTaskController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供员工端入职任务访问相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "员工入职填写")]
 [Route("open/onboarding")]
 [AllowAnonymous]
@@ -14,22 +17,31 @@ public class OnboardingPublicTaskController
         _fileService = fileService;
     }
 
+    /// <summary>
+    /// 通过 Token 获取员工端入职任务详情。
+    /// </summary>
     [HttpPost("detail")]
     public async Task<dynamic> Detail([FromBody] OnboardingTaskPublicAccessInput input)
     {
         return await _service.Detail(input);
     }
 
+    /// <summary>
+    /// 保存候选人固定基础信息。
+    /// </summary>
     [HttpPost("save-employee-info")]
     public async Task SaveEmployeeInfo([FromBody] OnboardingTaskPublicSaveInput input)
     {
         await _service.SaveEmployeeInfo(input);
     }
 
+    /// <summary>
+    /// 下载当前任务锁定的合同模板源文件。
+    /// </summary>
     [HttpGet("contract-source")]
     public async Task<FileStreamResult> ContractSource([FromQuery] OnboardingPublicContractSourceInput input)
     {
         var fileId = await _service.GetContractSourceFileId(input);
         return await _fileService.Download(new BaseIdInput { Id = fileId });
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingTaskContractVariableController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供任务合同变量维护相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职任务合同参数")]
 [Route("biz/onboarding/task-contract-variable")]
 [RolePermission]
@@ -12,15 +15,21 @@ public class OnboardingTaskContractVariableController
         _service = service;
     }
 
+    /// <summary>
+    /// 查询任务合同变量。
+    /// </summary>
     [HttpGet("list")]
     public async Task<dynamic> List([FromQuery] OnboardingTaskContractVariableQueryInput input)
     {
         return await _service.List(input);
     }
 
+    /// <summary>
+    /// 保存任务合同变量。
+    /// </summary>
     [HttpPost("save")]
     public async Task Save([FromBody] OnboardingTaskContractVariableSaveInput input)
     {
         await _service.Save(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingTaskController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职任务创建相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职任务")]
 [Route("biz/onboarding/task")]
 [RolePermission]
@@ -12,9 +15,12 @@ public class OnboardingTaskController
         _service = service;
     }
 
+    /// <summary>
+    /// 创建入职任务并返回员工填写链接。
+    /// </summary>
     [HttpPost("create")]
     public async Task<dynamic> Create([FromBody] OnboardingTaskCreateInput input)
     {
         return await _service.Create(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingTaskLifecycleController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职任务生命周期相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职任务归档")]
 [Route("biz/onboarding/task")]
 [RolePermission]
@@ -12,15 +15,21 @@ public class OnboardingTaskLifecycleController
         _service = service;
     }
 
+    /// <summary>
+    /// 归档审核通过的入职任务。
+    /// </summary>
     [HttpPost("archive")]
     public async Task Archive([FromBody] OnboardingAuditActionInput input)
     {
         await _service.Archive(input);
     }
 
+    /// <summary>
+    /// 撤销入职任务及员工填写链接。
+    /// </summary>
     [HttpPost("revoke")]
     public async Task Revoke([FromBody] OnboardingAuditActionInput input)
     {
         await _service.Revoke(input);
     }
-}
+}

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingTaskQueryController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供入职任务查询相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职任务查询")]
 [Route("biz/onboarding/task")]
 [RolePermission]
@@ -12,15 +15,21 @@ public class OnboardingTaskQueryController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询入职任务。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingTaskPageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询入职任务完整详情。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
-}
+}