Repository navigation
docs: match HttpApi guidance to the typed client - #163
Merged
Merged
Conversation
The web README still described the removed BackgroundSessionsClient, and the HttpApi skill still named Effect import paths that 4.0.3 does not export. Co-authored-by: Jonathan Beckman <jonathantbeckman@gmail.com>
jonbeckman
marked this pull request as ready for review
November 1, 2026 09:15
Contributor
TegamiThis repository uses Tegami to manage releases. When your changes affect published packages, add a changelog file under Create a changelog → · Changelog format Release preview
This PR does not add changelog files. Pending changelogs from other branches are included in the preview above. Run Managed by Tegami. |
Contributor
🟢 e2e solzero-core: 9 passed, 37 left out by filters1 agent step · 1 replayed from cache Change 3 files changed since 37 tests left out by filters
All 9 tests in 6 files
e2e 0.21.3 · 29.2s · local-cloudflare · run artifacts |
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
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.
Summary
The web client README still documented
BackgroundSessionsClientfromapps/web/src/session-client.ts, which the typed-client work removed. The HttpApi skill still told agents to importeffect/unstable/httpapiandeffect/unstable/observability/Otlp, and to add Maple. Effect 4.0.3 exportseffect/http-apiandeffect/observability/Otlp, and this repository does not install Maple.apps/web/README.mdnow showsmakeS0ApiClientfrom@solzero/api, and describes/apias theS0Apicontract on the web origin..agents/skills/effect-httpapi-workers-patterns/SKILL.mdnames the current Effect import paths and keeps Cloudflare Worker Observability as the deployed log and trace path.makeS0ApiClientnotes thatbearerTokenis sent asAuthorization: Bearer.This is documentation and a comment. It does not change runtime behavior, so it uses
release:noneand does not add a Tegami entry.No source files were deleted.
apps/web/src/session-client.tswas already absent onmaster.Search before the edit:
rg -n "BackgroundSessionsClient|from \"./src/session-client\""matched onlyapps/web/README.mdand the historical note in.tegami/2026-10-29-session-page-actions.md.test ! -e apps/web/src/session-client.ts— the module file is not in the tree.rg -n "effect/unstable/httpapi|effect/unstable/observability" --glob '!node_modules/**'matched only.agents/skills/effect-httpapi-workers-patterns/SKILL.md.rg -n "from \"effect/http-api\"" packages apps testsmatches the current contract, server routes, andapps/web/src/lib/api-client.ts.node_modules/effect/package.jsonexports./http-apiand./observability.effect/dist/observability/Otlp.jsexists. There is noeffect/unstable/httpapiexport.rg -n "@maple-dev|maple start" --glob '!node_modules/**' --glob '!.agents/**'had no matches. Nopackage.jsondepends on Maple.Open PRs #89, #75, and #155 were left untouched, including
docs/e2e.md,AGENTS.md, rootREADME.md,scripts/e2e/*, and the version-package files.Validation
nub run formatnub run lintnub run typechecknub run config:checkA temporary copy of the README snippet was typechecked with
@solzero/apiand then deleted.sessionKindis required on the client payload type, so the example includessessionKind: "isolate".nub run testwas not run: the diff does not change runtime behavior, and no end-to-end test covers these docs.Checklist
.tegami/release entry, or explained why this pull request usesrelease:none.nub run config:check,nub run typecheck,nub run lint,nub run format, andnub run test.THIRD_PARTY_NOTICES.mdfor new third-party code or separately licensed assets.config:check,typecheck,lint, andformatpassed.nub run testdid not run, for the reason in Validation.