redb.Tsak.Contracts 3.3.1

redb.Tsak.Contracts

Shared DTO (Data Transfer Object) library for the redb.Tsak management API. Contains all request and response types that flow between the Tsak Worker (server) and consumers: the typed HTTP client (redb.Tsak.Client), the CLI (redb.Tsak.CLI), the Web dashboard, and any third-party integration.

Why a dedicated contracts assembly?

• Zero external dependencies — no NuGet packages beyond the .NET SDK. Can be referenced anywhere without pulling in server-side dependencies.
• Shared source of truth — both redb.Tsak.Core (server controllers) and redb.Tsak.Client (HTTP client) reference this single assembly, eliminating DTO drift.
• Stable API surface — the types in this assembly form the public REST API contract. Additive changes are backwards-compatible; breaking changes follow semver.

Install

dotnet add package redb.Tsak.Contracts

Usually you do not reference this package directly. It is pulled in transitively by redb.Tsak.Client.

Model reference

All types are sealed record with init-only properties, serialized with System.Text.Json (case-insensitive, enum-as-string).

Auth (AuthModels.cs)

public sealed record ApiKeyCreatedResponse
{
    public required string Id       { get; init; }
    public required string Key      { get; init; } // raw key — save it now
    public required string Name     { get; init; }
    public required string Roles    { get; init; }
    public string?         UserId   { get; init; }
    public required DateTimeOffset CreatedAt { get; init; }
    public DateTimeOffset? ExpiresAt { get; init; }
    public string? Message { get; init; }
}

Cluster (ClusterModels.cs, ClusterTopology.cs, NodeStatus.cs)

Contexts (ContextModels.cs)

ContextActionResponse carries drain telemetry useful for capacity planning:

public sealed record ContextActionResponse
{
    public required string Name    { get; init; }
    public string?         Status  { get; init; }
    public bool?           Removed { get; init; }
    public int?  InflightBefore    { get; init; } // exchanges at stop initiation
    public int?  InflightAfter     { get; init; } // exchanges after drain (0 = fully drained)
    public long? DrainTimeMs       { get; init; } // time spent draining
}

Diagnostics (DiagnosticModels.cs)

Lifecycle (LifecycleModels.cs)

Logs (LogModels.cs)

Metrics (MetricsModels.cs)

Modules (ModuleModels.cs)

Scheduler (SchedulerModels.cs)

System (SystemModels.cs)

Users (UserModels.cs)

Watchdog (WatchdogModels.cs)

Serialization conventions

All types are designed for System.Text.Json with these settings (applied by TsakApiClient):

new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    Converters = { new JsonStringEnumConverter() }
}

Enum values serialize as their string names (e.g. "Active", not 2). All date/time values use DateTimeOffset (UTC).

Versioning

This assembly follows Semantic Versioning:

• Additive changes (new optional properties, new enum members) → patch/minor bump, fully backwards-compatible.
• Renames or removals → major version bump, coordinated with redb.Tsak.Core and redb.Tsak.Client.

Current version: 1.0.4

Related projects