deploy: 8dbcc517a4

auriondocs/Code/src/EchoHub.Core/DTOs/ServerDtos.cs.md

@@ -24,11 +24,13 @@ public record EncryptionKeyResponse(string Key)
 | `Key` | `string` | — |
 
 
-EncryptionKeyResponse is a minimal, strongly-typed envelope used to return an encryption key from server-side DTOs. It is implemented as a C# `record` with a single property `string Key`, providing value-based equality and convenient deconstruction while keeping the surface area stable for serialization and future extension.
+`EncryptionKeyResponse` is a concise data-transfer `record` that carries a single string property named `Key`, representing an encryption key. Use this type when an API response or internal boundary needs to convey the key as a structured envelope rather than a raw string, benefiting from the immutability and value-based equality of a `record`.
 
 ## Remarks
-Using a one-property `record` as a DTO provides a stable, strongly-typed surface for returning the key, while enabling easy evolution (e.g., adding metadata like algorithm, expiration, or salt) without breaking client contracts. It also leverages `record` semantics to support value-based equality and clean deconstruction when used in responses.
+By modeling the payload as its own type, this symbol helps keep key handling explicit and self-describing across boundaries. It pairs with other server DTOs to form a consistent contract for encryption-related data, and it can evolve to carry extra metadata (expiry, algorithm) without breaking existing clients.
 
+## Notes
+- Treat the `Key` as sensitive data; avoid logging it or exposing it in traces. Ensure it is transmitted only over secure channels and managed according to your security policy.
 
 ---
 
@@ -42,7 +44,8 @@ public record ServerStatusDto(
     string? Description,
     int OnlineUsers,
     int TotalChannels,
-    string RegistrationMode = "open")
+    string RegistrationMode = "open",
+    string Version = "0.0.0")
 ```
 
 **Parameters:**
@@ -54,15 +57,22 @@ public record ServerStatusDto(
 | `OnlineUsers` | `int` | — |
 | `TotalChannels` | `int` | — |
 | `RegistrationMode` | `string` | `"open"` |
+| `Version` | `string` | `"0.0.0"` |
 
 
-Represents a lightweight, immutable snapshot of a server's status for transport between layers or to clients. It exposes the server's `Name`, optional `Description`, current `OnlineUsers`, total `TotalChannels`, and the `RegistrationMode` (defaulting to `open` when not provided).
+Represents a compact, immutable data transfer object that conveys a server's identity and current activity. It exposes the server's `Name`, optional `Description`, the `OnlineUsers` count, the `TotalChannels`, and optional `RegistrationMode` and `Version` (defaulting to `"open"` and `"0.0.0"` when omitted). Use this DTO in API responses or status endpoints to deliver a stable snapshot of server state.
 
 ## Remarks
-Because this is a `record`, it uses value-based equality and immutable properties, making it ideal as a DTO boundary between internal domain models and external consumers. Construct this type from your server state when returning status information to clients, rather than leaking domain entities.
+Because it is a `record`, `ServerStatusDto` benefits from value-based equality and deconstruction semantics, making it convenient to compare status payloads in tests or across clients. The trailing `RegistrationMode` and `Version` parameters are optional in construction, allowing callers to supply just the core metrics while still producing a complete payload. This DTO isolates status representation from internal domain entities and keeps the shape stable for clients and tooling.
+
+## Example
+```csharp
+// Minimal construction: Description omitted (use null)
+var status = new ServerStatusDto("EchoHub", null, 12, 3);
+
+// Full construction with explicit values
+var statusFull = new ServerStatusDto("EchoHub", "Main gateway", 12, 3, "open", "1.2.0");
+```
 
-## Notes
-- `Description` is nullable (`string?`). Guard against null or provide a fallback when presenting it to callers.
-- To derive a modified copy (e.g., update `OnlineUsers`), use the `with` expression since `ServerStatusDto` is immutable.
 
 ---