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:
@@ -4,12 +4,12 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.InboundApi;
|
||||
namespace ZB.MOM.WW.ScadaBridge.InboundAPI;
|
||||
|
||||
/// <summary>
|
||||
/// WP-2: Validates and deserializes a JSON request body against a method's
|
||||
/// Validates and deserializes a JSON request body against a method's
|
||||
/// parameter definitions. Extended type system: Boolean, Integer, Float,
|
||||
/// String, Object, List.
|
||||
///
|
||||
/// <para>
|
||||
/// InboundAPI-M2.6: validation is now RECURSIVE and type-aware for the
|
||||
/// Validation is now RECURSIVE and type-aware for the
|
||||
/// extended <c>Object</c> / <c>List</c> types. Declared object fields are
|
||||
/// validated against their declared (nested) types, list elements against the
|
||||
/// declared element type, and scalars at any depth against the extended type —
|
||||
@@ -31,7 +31,7 @@ public static class ParameterValidator
|
||||
/// <param name="body">The parsed JSON request body; null or undefined if no body was supplied.</param>
|
||||
/// <param name="parameterDefinitions">JSON Schema describing the method's parameters (an object schema), or null/empty when no parameters are defined. The legacy flat-array form is also accepted.</param>
|
||||
/// <param name="resolveRef">
|
||||
/// M9-T32b: optional JSON-Schema <c>$ref</c> resolution seam mapping a
|
||||
/// Optional JSON-Schema <c>$ref</c> resolution seam mapping a
|
||||
/// <c>{"$ref":"lib:Name"}</c> reference target's name to the referenced schema JSON
|
||||
/// (or <c>null</c> when the library entry does not exist). The endpoint pre-loads the
|
||||
/// shared-schema library (backed by <c>ISharedSchemaRepository</c>) and supplies it
|
||||
@@ -46,7 +46,7 @@ public static class ParameterValidator
|
||||
string? parameterDefinitions,
|
||||
Func<string, string?>? resolveRef = null)
|
||||
{
|
||||
// M9-T32b: parse through the ref-COLLECTING path. A {"$ref":"lib:Name"} that the
|
||||
// Parse through the ref-COLLECTING path. A {"$ref":"lib:Name"} that the
|
||||
// resolver can satisfy is resolved inline; a dangling/cyclic/over-depth ref is
|
||||
// collected (not thrown) so the runtime returns a descriptive "could not be
|
||||
// resolved" message instead of an opaque "Invalid parameter definitions" — the
|
||||
@@ -119,7 +119,7 @@ public static class ParameterValidator
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// M9-T32b: renders the unresolved <c>{"$ref":"lib:Name"}</c> references for a clear,
|
||||
/// Renders the unresolved <c>{"$ref":"lib:Name"}</c> references for a clear,
|
||||
/// descriptive runtime error — the bare <c>lib:</c>-qualified pointer name stays
|
||||
/// separate from any parenthesised reason (cyclic/over-depth), so the message reads
|
||||
/// e.g. <c>schema(s) 'lib:Foo' (cyclic reference)</c> rather than embedding the
|
||||
@@ -137,7 +137,7 @@ public static class ParameterValidator
|
||||
/// arrays to <see cref="List{T}"/>.
|
||||
///
|
||||
/// <para>
|
||||
/// InboundAPI-#55: coercion is RECURSIVE. Nested object fields and list
|
||||
/// Coercion is RECURSIVE. Nested object fields and list
|
||||
/// elements are coerced to typed CLR values too (string/long/double/bool,
|
||||
/// or nested Dictionary/List), so NO raw <see cref="JsonElement"/> survives
|
||||
/// anywhere in the returned graph. Previously the <c>object</c> case used
|
||||
@@ -254,7 +254,7 @@ public static class ParameterValidator
|
||||
{
|
||||
// Declared object/array element: recurse via Materialize so each
|
||||
// element follows its declared (nested) schema — nested scalars
|
||||
// become typed CLR values, never raw JsonElement (#55).
|
||||
// become typed CLR values, never raw JsonElement.
|
||||
var list = new List<object?>(element.GetArrayLength());
|
||||
foreach (var e in element.EnumerateArray()) list.Add(Materialize(e, items));
|
||||
return list;
|
||||
|
||||
Reference in New Issue
Block a user