docs: add XML documentation and ConfigManager implementation plans
Add comprehensive XML documentation (param/returns tags) across 132 source files to improve IntelliSense and API discoverability. Include ConfigManager design documents and implementation plans for phases 1-9.
This commit is contained in:
@@ -20,6 +20,12 @@ public class PipelineController : ApiControllerBase
|
||||
private readonly IDataUpdateRepository _dataUpdateRepository;
|
||||
private readonly IPipelineMapper _mapper;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PipelineController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="pipelineFactory">The ETL pipeline factory.</param>
|
||||
/// <param name="dataUpdateRepository">The data update repository.</param>
|
||||
/// <param name="mapper">The pipeline mapper.</param>
|
||||
public PipelineController(
|
||||
IEtlPipelineFactory pipelineFactory,
|
||||
IDataUpdateRepository dataUpdateRepository,
|
||||
@@ -45,6 +51,7 @@ public class PipelineController : ApiControllerBase
|
||||
/// <summary>
|
||||
/// Gets configuration for a specific pipeline.
|
||||
/// </summary>
|
||||
/// <param name="name">The pipeline name.</param>
|
||||
[HttpGet(ApiRoutes.Pipelines.ByName)]
|
||||
public ActionResult<PipelineConfigDto> GetPipeline(string name)
|
||||
{
|
||||
@@ -60,6 +67,8 @@ public class PipelineController : ApiControllerBase
|
||||
/// <summary>
|
||||
/// Gets schedule status for a pipeline.
|
||||
/// </summary>
|
||||
/// <param name="name">The pipeline name.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
[HttpGet(ApiRoutes.Pipelines.Status)]
|
||||
public async Task<ActionResult<PipelineStatusResponse>> GetStatus(
|
||||
string name,
|
||||
@@ -104,6 +113,9 @@ public class PipelineController : ApiControllerBase
|
||||
/// <summary>
|
||||
/// Gets recent execution history for a pipeline.
|
||||
/// </summary>
|
||||
/// <param name="name">The pipeline name.</param>
|
||||
/// <param name="count">The maximum number of recent executions to retrieve.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
[HttpGet(ApiRoutes.Pipelines.Executions)]
|
||||
public async Task<ActionResult<PipelineExecutionsResponse>> GetExecutions(
|
||||
string name,
|
||||
|
||||
Reference in New Issue
Block a user