Joseph Doherty
eabf270d71
Resolve all 622 issues flagged by the enhanced CommentChecker: add missing <returns> tags (incl. the standard phrasing on non-generic Task methods), add missing <summary> tags, and replace misused/redundant <inheritdoc/> on members that override or implement nothing with real documentation. Documentation-only — no behavior change; solution builds clean.
31 lines
1.2 KiB
C#
31 lines
1.2 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
|
|
|
/// <summary>
|
|
/// Abstraction over the TemplateEngine flattening + validation + hashing pipeline.
|
|
/// Used by DeploymentService to obtain a validated, hashed FlattenedConfiguration.
|
|
/// </summary>
|
|
public interface IFlatteningPipeline
|
|
{
|
|
/// <summary>
|
|
/// Flattens and validates an instance configuration, returning the configuration,
|
|
/// revision hash, and validation result.
|
|
/// </summary>
|
|
/// <param name="instanceId">Id of the instance to flatten and validate.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A task that resolves to the flattened configuration, revision hash, and validation result; or a failure result if flattening could not complete.</returns>
|
|
Task<Result<FlatteningPipelineResult>> FlattenAndValidateAsync(
|
|
int instanceId,
|
|
CancellationToken cancellationToken = default);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Result of the flattening pipeline: configuration, hash, and validation.
|
|
/// </summary>
|
|
public record FlatteningPipelineResult(
|
|
FlattenedConfiguration Configuration,
|
|
string RevisionHash,
|
|
ValidationResult Validation);
|