docs: record detail-envelope override and future-work follow-ups - #16
Merged
Conversation
Close out the final whole-spec review with two doc-only notes (no code
change):
- ASSUMPTIONS.md: document that GET /hotels/:id is wrapped as { data }
as a *deliberate* override of the spec's "single-resource detail is
returned directly" — uniform envelope over a stale spec line, with
rationale, so the divergence is a recorded decision rather than silent.
- README "Future work": note the deferred follow-ups the review surfaced
— extracting the triplicated test factories (and the repeated 404
guard), and pushing filters into the store if the catalogue grows.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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
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.
Closes out the final whole-spec confidence pass. Docs only — no code change.
Changes
ASSUMPTIONS.md— record thatGET /hotels/:idis wrapped as{ data }as a deliberate override of the spec's "single-resource detail is returned directly." Uniform envelope over a stale spec line, with rationale, so the divergence is a documented decision rather than silent.README→ "Future work" — note the deferred follow-ups the review surfaced: extracting the triplicatedmakeRoom/makePropertytest factories (and the repeated 404 guard), and pushing filters into the store if the catalogue grows.Also left a note on (now-closed) issue #1 flagging the superseded spec line.
Verification
npm run verify: clean, 54/54 pass.🤖 Generated with Claude Code