docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
Joseph Doherty
@@ -1,12 +1,12 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// T17 / D6 — OPC UA server-certificate trust management.
|
||||
// OPC UA server-certificate trust management.
|
||||
//
|
||||
// Cert trust is SITE-LOCAL: there is no central persistence of trusted server
|
||||
// certificates. The trusted-peer PKI store lives on each site node's file
|
||||
// system, so a trust/remove decision must reach BOTH site nodes (node-a and
|
||||
// node-b) or the two PKI stores diverge across failover (Decision D6).
|
||||
// node-b) or the two PKI stores diverge across failover.
|
||||
//
|
||||
// The public commands below are handled by the site Deployment Manager
|
||||
// singleton (active node only). For trust/remove it broadcasts the
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
|
||||
// M9-T32c — schema-library authoring commands. The reusable named JSON-Schema
|
||||
// library (the SharedSchema entity + ISharedSchemaRepository, T32a) gains its CRUD
|
||||
// Schema-library authoring commands. The reusable named JSON-Schema
|
||||
// library (the SharedSchema entity + ISharedSchemaRepository) gains its CRUD
|
||||
// surface here. These records travel the same HTTP / ClusterClient management
|
||||
// boundary as every other *Command and are auto-discovered by reflection in
|
||||
// ManagementCommandRegistry (no manual registry entry needed).
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
|
||||
// ============================================================================
|
||||
// Two-person ("secured") write commands (M7 OPC UA / MxGateway UX, Task T14b).
|
||||
// Two-person ("secured") write commands.
|
||||
//
|
||||
// An Operator SUBMITS a pending secured write against an MxGateway data
|
||||
// connection; a distinct Verifier later APPROVES (executes — Task C3) or
|
||||
// connection; a distinct Verifier later APPROVES (executes) or
|
||||
// REJECTS it. Separation of duties is enforced at the handler: a write may not
|
||||
// be verified by the same principal that submitted it. ListSecuredWrites is a
|
||||
// read-only query (any authenticated user). Role gating lives in
|
||||
@@ -33,9 +33,9 @@ public record SubmitSecuredWriteCommand(
|
||||
string? Comment);
|
||||
|
||||
/// <summary>
|
||||
/// Verifier request to approve (and execute — handled by Task C3) a pending
|
||||
/// Verifier request to approve (and execute) a pending
|
||||
/// secured write. Declared here so the secured-write contract is complete; the
|
||||
/// approve→execute relay handler and dispatch arm are implemented in C3.
|
||||
/// approve→execute relay handler and dispatch arm are implemented separately.
|
||||
/// </summary>
|
||||
/// <param name="Id">Identity of the pending secured write.</param>
|
||||
/// <param name="Comment">Optional free-text comment supplied by the verifier.</param>
|
||||
|
||||
@@ -5,7 +5,7 @@ public record GetTemplateCommand(int TemplateId);
|
||||
public record CreateTemplateCommand(string Name, string? Description, int? ParentTemplateId);
|
||||
|
||||
/// <summary>
|
||||
/// Updates a template. Optional fields use leave-unchanged semantics (followup #5):
|
||||
/// Updates a template. Optional fields use leave-unchanged semantics:
|
||||
/// a <c>null</c> <see cref="Description"/> keeps the stored description (pass an empty
|
||||
/// string to clear it), and a <c>null</c> <see cref="ParentTemplateId"/> keeps the
|
||||
/// existing parent (the parent is immutable; a non-null value that differs is rejected).
|
||||
@@ -15,7 +15,7 @@ public record DeleteTemplateCommand(int TemplateId);
|
||||
public record ValidateTemplateCommand(int TemplateId);
|
||||
|
||||
/// <summary>
|
||||
/// Read-only authoring query (M9/T26a): returns the EFFECTIVE inherited member
|
||||
/// Read-only authoring query: returns the EFFECTIVE inherited member
|
||||
/// set for a template — computed fresh from the full inheritance chain
|
||||
/// (arbitrary depth), annotated per member with origin + lock state — plus a
|
||||
/// staleness summary comparing the template's stored rows against the resolved
|
||||
@@ -52,7 +52,7 @@ public record ListTemplateNativeAlarmSourcesCommand(int TemplateId);
|
||||
// MinTimeBetweenRuns mirrors the TemplateScript.MinTimeBetweenRuns TimeSpan throttle/re-fire interval;
|
||||
// ExecutionTimeoutSeconds mirrors the per-script TemplateScript.ExecutionTimeoutSeconds override (seconds;
|
||||
// null/non-positive falls back to the site's global default). Both were previously settable only via
|
||||
// Transport bundle import — these fields close the CLI/UI authoring gap (#54). Additive-only: never reorder.
|
||||
// Transport bundle import — these fields close the CLI/UI authoring gap. Additive-only: never reorder.
|
||||
public record AddTemplateScriptCommand(int TemplateId, string Name, string Code, string? TriggerType, string? TriggerConfiguration, bool IsLocked, string? ParameterDefinitions = null, string? ReturnDefinition = null, TimeSpan? MinTimeBetweenRuns = null, int? ExecutionTimeoutSeconds = null);
|
||||
public record UpdateTemplateScriptCommand(int ScriptId, string Name, string Code, string? TriggerType, string? TriggerConfiguration, bool IsLocked, string? ParameterDefinitions = null, string? ReturnDefinition = null, TimeSpan? MinTimeBetweenRuns = null, int? ExecutionTimeoutSeconds = null);
|
||||
public record DeleteTemplateScriptCommand(int ScriptId);
|
||||
|
||||
@@ -8,7 +8,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
/// name lists and exports every entity of every supported type.
|
||||
/// <para>
|
||||
/// Inbound API keys are intentionally not selectable: per the inbound-API-key
|
||||
/// re-architecture (C4) keys are not transported between environments; only API
|
||||
/// re-architecture keys are not transported between environments; only API
|
||||
/// methods travel. Re-create keys and re-grant their method scopes on the
|
||||
/// destination via the admin UI/CLI.
|
||||
/// </para>
|
||||
@@ -25,13 +25,13 @@ public sealed record ExportBundleCommand(
|
||||
bool IncludeDependencies,
|
||||
string? Passphrase,
|
||||
string SourceEnvironment,
|
||||
// Additive (M8 B4): site/instance-scoped selection. Sites resolve by
|
||||
// Additive: site/instance-scoped selection. Sites resolve by
|
||||
// SiteIdentifier (preferred) or Name; instances resolve by UniqueName.
|
||||
// Defaulted null so every existing positional caller keeps compiling; the
|
||||
// handler normalizes null to "select nothing" (or everything under All=true).
|
||||
IReadOnlyList<string>? SiteNames = null,
|
||||
IReadOnlyList<string>? InstanceNames = null,
|
||||
// Additive (S10b): SMS provider config selection, mirroring
|
||||
// Additive: SMS provider config selection, mirroring
|
||||
// SmtpConfigurationNames. SmsConfiguration is keyed by AccountSid (no Name
|
||||
// column), so tokens are AccountSid values. Defaulted null so every existing
|
||||
// positional caller keeps compiling.
|
||||
@@ -59,17 +59,17 @@ public sealed record PreviewBundleResult(
|
||||
int ModifiedCount,
|
||||
int IdenticalCount,
|
||||
int BlockerCount,
|
||||
// Additive (M8 D3): site/connection references the operator must resolve
|
||||
// Additive: site/connection references the operator must resolve
|
||||
// before import, carried verbatim from ImportPreview. Defaulted to empty so
|
||||
// every existing positional caller keeps compiling.
|
||||
IReadOnlyList<RequiredSiteMapping>? RequiredSiteMappings = null,
|
||||
IReadOnlyList<RequiredConnectionMapping>? RequiredConnectionMappings = null)
|
||||
{
|
||||
/// <summary>Site references the operator must resolve before import (M8). Never null.</summary>
|
||||
/// <summary>Site references the operator must resolve before import. Never null.</summary>
|
||||
public IReadOnlyList<RequiredSiteMapping> RequiredSiteMappings { get; init; } =
|
||||
RequiredSiteMappings ?? Array.Empty<RequiredSiteMapping>();
|
||||
|
||||
/// <summary>Connection references the operator must resolve before import (M8). Never null.</summary>
|
||||
/// <summary>Connection references the operator must resolve before import. Never null.</summary>
|
||||
public IReadOnlyList<RequiredConnectionMapping> RequiredConnectionMappings { get; init; } =
|
||||
RequiredConnectionMappings ?? Array.Empty<RequiredConnectionMapping>();
|
||||
}
|
||||
@@ -108,7 +108,7 @@ public sealed record ConnectionMappingSpec(
|
||||
/// <c>"overwrite"</c>, <c>"rename"</c>. Rename mints a unique suffix per row.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// M8 (D3): <paramref name="SiteMappings"/> / <paramref name="ConnectionMappings"/>
|
||||
/// <paramref name="SiteMappings"/> / <paramref name="ConnectionMappings"/>
|
||||
/// supply explicit operator resolutions for the source-environment site/connection
|
||||
/// references the bundle carries; the handler merges them with the preview's
|
||||
/// auto-matches and the <paramref name="CreateMissingSites"/> /
|
||||
|
||||
Reference in New Issue
Block a user