docs: add frontend integration guide#9
Merged
Conversation
Co-authored-by: Mr T <trenchsheikh@users.noreply.github.com>
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.
Adds
backend/docs/FRONTEND_INTEGRATION.md, a practical guide for thefrontend team on how to wire up to the UnderWriter backend.
What's covered
/api/health,/api/run,/api/memo/{runId},/api/amend) with request/response shapes.contract.tstypes (DeskFinding,Verdict,RunEvent,MemoData,OverrideContext,AmendmentDraft) and three options for sharing the file with the frontend.EventSourcewon't work forPOST, a copy-pasteable streaming reader (lifted fromscripts/smoke.ts), and a suggesteduseReducerstate model.clean-acmePASS /bec-acmeBLOCK + amendment).The guide is read-only documentation — no code changes — so no testing needed beyond rendering the markdown.
Slack Thread