You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
close() should imply flush() (or the docs should say when flush() alone is meaningful). The quick start requires both in order; today Stack.close() only calls adapter.close?.(), and correctness silently depends on each adapter's close being flush-inclusive. Making Stack.close() call flush() first is the common file-like-API expectation.
Discovery "version": "1.0" has no defined semantics — no negotiation rule, no compatibility statement. Before a server ships with it, decide what a client should do with it (refuse on major mismatch?) or drop it until it means something.
handle fields claim "short unique identifier" (_entity, _group) but nothing enforces or indexes uniqueness. Fine — but the doc comments should say "uniqueness by convention, not enforced" so app authors don't build lookup logic on a guarantee that isn't there.
putAttachment() returns only the fileId while POST /attachments returns the full _attachment@1 record; a caller wanting their metadata record's id (e.g. to set a filename later) must query for it. Returning the record (or { fileId, record }) matches the wire shape — worth deciding before the signature is load-bearing for external apps, since it's a breaking change to StackClient.
From
docs/design-review-2026-08.md§B6 — small independent items, batched like #69 was.close()should implyflush()(or the docs should say whenflush()alone is meaningful). The quick start requires both in order; todayStack.close()only callsadapter.close?.(), and correctness silently depends on each adapter's close being flush-inclusive. MakingStack.close()callflush()first is the common file-like-API expectation."version": "1.0"has no defined semantics — no negotiation rule, no compatibility statement. Before a server ships with it, decide what a client should do with it (refuse on major mismatch?) or drop it until it means something.handlefields claim "short unique identifier" (_entity,_group) but nothing enforces or indexes uniqueness. Fine — but the doc comments should say "uniqueness by convention, not enforced" so app authors don't build lookup logic on a guarantee that isn't there.putAttachment()returns only thefileIdwhilePOST /attachmentsreturns the full_attachment@1record; a caller wanting their metadata record's id (e.g. to set afilenamelater) must query for it. Returning the record (or{ fileId, record }) matches the wire shape — worth deciding before the signature is load-bearing for external apps, since it's a breaking change toStackClient.Cross-refs: design-review-2026-08 §B6.