TechStrap.Contracts
0.1.0
See the version list below for details.
dotnet add package TechStrap.Contracts --version 0.1.0
NuGet\Install-Package TechStrap.Contracts -Version 0.1.0
<PackageReference Include="TechStrap.Contracts" Version="0.1.0" />
<PackageVersion Include="TechStrap.Contracts" Version="0.1.0" />
<PackageReference Include="TechStrap.Contracts" />
paket add TechStrap.Contracts --version 0.1.0
#r "nuget: TechStrap.Contracts, 0.1.0"
#:package TechStrap.Contracts@0.1.0
#addin nuget:?package=TechStrap.Contracts&version=0.1.0
#tool nuget:?package=TechStrap.Contracts&version=0.1.0
TechStrap.Contracts
The wire contracts of TechStrap, the self-hosted support desk: the request and response types, header names, route constants and size limits that the intake API and its clients share. It has no dependencies, so any .NET client can reference it.
What it contains
SubmitTicketRequestandSubmitTicketResponse, the JSON bodies ofPOST /api/intake/tickets.HeaderNames: theX-Api-Key,X-Ticket-TokenandIdempotency-Keyheader names.IntakeRoutes: the intake route constants.IntakeLimits: the size limits the API enforces (subject, body, metadata keys and values, idempotency key length).TicketMetadataKeys: the well-known metadata keys (app.version,os.platformand the rest) that device-aware clients fill in.
Stability
The package follows semantic versioning, scoped as follows. v1.0.0 locks the SDK-facing surface of TechStrap.Contracts: the TechStrap.Contracts.Intake namespace (SubmitTicketRequest, SubmitTicketResponse, IntakeLimits, IntakeRoutes, IntakeWarnings, TicketMetadataKeys) and TechStrap.Contracts.Http.HeaderNames. The other namespaces (Admin, Agents, ApiKeys, Kb, Live, AdminEvents, Tickets and so on) are TechStrap's own app wire shapes, shared with its Admin and Portal, and may change in minor versions. Before 1.0.0 (the 0.x versions, starting with 0.1.0), the SDK-facing surface can still change in a minor version; after it, a breaking change there ships only in a new major version. Package validation is enabled; its baseline comparison against the previous release starts after 1.0.0.
Using it
You normally get this package through TechStrap.Client, which wraps these contracts in a typed HTTP client with retries and typed errors. Reference TechStrap.Contracts directly only if you write your own client.
More: https://github.com/Syntax-Circus/techstrap/blob/main/docs/development/CLIENT-SDK.md
Source and issues: https://github.com/Syntax-Circus/techstrap
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- No dependencies.
NuGet packages (2)
Showing the top 2 NuGet packages that depend on TechStrap.Contracts:
| Package | Downloads |
|---|---|
|
TechStrap.Client
Client SDK for TechStrap: submit support tickets to a TechStrap API from any .NET app, with an API key, retries and typed errors. |
|
|
TechStrap.Client.Maui
Device and app metadata capture and a submit-ticket helper for MAUI apps, on top of TechStrap.Client. |
GitHub repositories
This package is not used by any popular GitHub repositories.