docs(dotnet-client): keep XML docs with their CLI members
Claude-Session: https://claude.ai/code/session_016J6isfcgqy4SB2RK3ZvFvT
This commit is contained in:
@@ -353,11 +353,16 @@ public static class MxGatewayClientCli
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
private const string DefaultVerifyPasswordEnvironmentName = "MXGATEWAY_VERIFY_PASSWORD";
|
private const string DefaultVerifyPasswordEnvironmentName = "MXGATEWAY_VERIFY_PASSWORD";
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Default environment variable holding the operator password for
|
||||||
|
/// <c>acknowledge-alarm</c> when <c>--operator-password-env</c> is not given.
|
||||||
|
/// </summary>
|
||||||
|
private const string OperatorPasswordEnvironmentName = "MXGATEWAY_OPERATOR_PASSWORD";
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Legacy environment variable, still honoured as a deprecated fallback
|
/// Legacy environment variable, still honoured as a deprecated fallback
|
||||||
/// for one release so existing scripts keep working.
|
/// for one release so existing scripts keep working.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private const string OperatorPasswordEnvironmentName = "MXGATEWAY_OPERATOR_PASSWORD";
|
|
||||||
private const string LegacyVerifyPasswordEnvironmentName = "MXGATEWAY_VERIFY_USER_PASSWORD";
|
private const string LegacyVerifyPasswordEnvironmentName = "MXGATEWAY_VERIFY_USER_PASSWORD";
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -381,14 +386,10 @@ public static class MxGatewayClientCli
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Resolves the effective MXAccess verify-user credential in this
|
/// Resolves the <c>acknowledge-alarm</c> operator password: <c>--operator-password</c>,
|
||||||
/// order: <c>--password</c>, the deprecated <c>--verify-user-password</c>
|
/// then the environment variable named by <c>--operator-password-env</c>
|
||||||
/// alias, the environment variable named by <c>--password-env</c> (default
|
/// (default <c>MXGATEWAY_OPERATOR_PASSWORD</c>). An empty value is treated as
|
||||||
/// <c>MXGATEWAY_VERIFY_PASSWORD</c>), then the deprecated
|
/// absent. The value is never echoed; it is also fed to the error redactor.
|
||||||
/// <c>MXGATEWAY_VERIFY_USER_PASSWORD</c>. An empty value from any source is
|
|
||||||
/// treated as absent. The credential is never echoed; this resolver exists so
|
|
||||||
/// the error-redaction catch block can strip it from any surfaced error,
|
|
||||||
/// mirroring <see cref="TryResolveApiKey" />.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static string? ResolveOperatorPassword(CliArguments arguments)
|
private static string? ResolveOperatorPassword(CliArguments arguments)
|
||||||
{
|
{
|
||||||
@@ -408,6 +409,16 @@ public static class MxGatewayClientCli
|
|||||||
return string.IsNullOrEmpty(password) ? null : password;
|
return string.IsNullOrEmpty(password) ? null : password;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Resolves the effective MXAccess verify-user credential in this
|
||||||
|
/// order: <c>--password</c>, the deprecated <c>--verify-user-password</c>
|
||||||
|
/// alias, the environment variable named by <c>--password-env</c> (default
|
||||||
|
/// <c>MXGATEWAY_VERIFY_PASSWORD</c>), then the deprecated
|
||||||
|
/// <c>MXGATEWAY_VERIFY_USER_PASSWORD</c>. An empty value from any source is
|
||||||
|
/// treated as absent. The credential is never echoed; this resolver exists so
|
||||||
|
/// the error-redaction catch block can strip it from any surfaced error,
|
||||||
|
/// mirroring <see cref="TryResolveApiKey" />.
|
||||||
|
/// </summary>
|
||||||
private static string? TryResolveVerifyUserPassword(CliArguments arguments)
|
private static string? TryResolveVerifyUserPassword(CliArguments arguments)
|
||||||
{
|
{
|
||||||
string? password = arguments.GetOptional("password");
|
string? password = arguments.GetOptional("password");
|
||||||
|
|||||||
Reference in New Issue
Block a user