fix(rest): ADR-0046 — /meta/doc list omits content by default#1790
Merged
Conversation
The runtime dispatcher's /metadata/doc route already slims doc list responses (#1789), but the console reads the REST server's /meta/:type route, which still returned full bodies. Apply the same rule here: list responses carry name + label only, ?include=content opts back in, and GET /meta/doc/:name always returns the full body. Found during live verification of the console /docs/:name route — the list endpoint is the path that must stay content-free because manuals are the one metadata payload that grows unbounded. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
1 task
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
2 participants
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
Follow-up to #1789. The ADR-0046 hard requirement — doc list responses carry
name+labelwithoutcontent— was implemented on the runtime dispatcher's/metadata/:typeroute, but the console actually reads the REST server'sGET /meta/:typeroute, which still returned full bodies. This applies the same slimming there: default list omitscontent,?include=contentopts back in, and the single-itemGET /meta/doc/:namealways returns the full body.Found during live E2E verification of the console
/docs/:nameroute (objectui #1677).Test plan
@objectstack/restbuild + tests green (107 passed)GET /api/v1/meta/docitems carry nocontent;?include=contentrestores it;GET /api/v1/meta/doc/todo_indexreturns the full body; console doc page renders end to end🤖 Generated with Claude Code