docs: add language-agnostic product and porting specification#211
Merged
Conversation
Add docs/product-spec.md, a normative, implementation-neutral specification of the SDK's behavior and contracts. It states the product thesis (an HTTP-client toolkit rather than a client), the pluggable seams and their discovery rules, the immutable HTTP model, both execution-pipeline layers, and the retry, redirect, authentication, pagination, streaming, serialization, observability, configuration, and transport/async-adapter contracts as RFC 2119 requirements. Each requirement carries a stable identifier, a rationale, and a conformance-test note, and the document closes with a glossary, a conformance checklist, and a consolidated requirement index, so the SDK can be reimplemented faithfully in another language or runtime.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/product-spec.md: a normative, implementation-neutral specification of the SDK's behavior and contracts, precise enough to reimplement the SDK faithfully in another language or runtime.Why
The SDK's design intent has lived in code, package layout, and scattered per-subsystem notes. This consolidates it into one reference that states what the SDK guarantees (not how the Kotlin/JVM implementation happens to do it), so a port can be built and audited against a single source of truth, and maintainers have one place that pins down the load-bearing invariants.
What's in it
RETRY-7), a one-line rationale, and a conformance-test note.Docs-only; no code or build changes.