[{"data":1,"prerenderedAt":350},["ShallowReactive",2],{"i-lucide:shapes":3,"i-lucide:server":8,"i-lucide:library":10,"i-lucide:list-checks":12,"i-lucide:waypoints":14,"i-lucide:calendar-range":16,"i-lucide:layers":18,"i-lucide:notebook-pen":20,"i-lucide:swords":22,"i-lucide:terminal":24,"i-lucide:list":26,"i-lucide:gauge":28,"i-lucide:webhook":30,"i-lucide:home":32,"i-lucide:layout-grid":34,"i-lucide:tag":36,"i-lucide:newspaper":38,"i-lucide:map":40,"i-lucide:flask-conical":42,"i-lucide:arrow-right":44,"i-lucide:book-open":46,"i-lucide:chevron-right":48,"i-lucide:search":50,"i-lucide:monitor":52,"content:\u002Fdocs\u002Fincludes":54,"i-lucide:info":348,"i-lucide:rocket":345,"i-lucide:key-round":345,"i-lucide:git-compare":345,"i-lucide:bot":345,"i-lucide:blocks":345,"i-lucide:fingerprint":345,"i-lucide:octagon-alert":345},{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":7},0,24,false,"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M8.3 10a.7.7 0 0 1-.626-1.079L11.4 3a.7.7 0 0 1 1.198-.043L16.3 8.9a.7.7 0 0 1-.572 1.1Z\"\u002F>\u003Crect width=\"7\" height=\"7\" x=\"3\" y=\"14\" rx=\"1\"\u002F>\u003Ccircle cx=\"17.5\" cy=\"17.5\" r=\"3.5\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":9},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"20\" height=\"8\" x=\"2\" y=\"2\" rx=\"2\" ry=\"2\"\u002F>\u003Crect width=\"20\" height=\"8\" x=\"2\" y=\"14\" rx=\"2\" ry=\"2\"\u002F>\u003Cpath d=\"M6 6h.01M6 18h.01\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":11},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m16 6l4 14M12 6v14M8 8v12M4 4v16\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":13},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M13 5h8m-8 7h8m-8 7h8M3 17l2 2l4-4M3 7l2 2l4-4\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":15},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m10.586 5.414l-5.172 5.172m13.172 2.828l-5.172 5.172M6 12h12\"\u002F>\u003Ccircle cx=\"12\" cy=\"20\" r=\"2\"\u002F>\u003Ccircle cx=\"12\" cy=\"4\" r=\"2\"\u002F>\u003Ccircle cx=\"20\" cy=\"12\" r=\"2\"\u002F>\u003Ccircle cx=\"4\" cy=\"12\" r=\"2\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":17},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"18\" height=\"18\" x=\"3\" y=\"3\" rx=\"2\"\u002F>\u003Cpath d=\"M16 2v3M3 9h18M8 2v3m9 8h-6m2 4H7m0-4h.01M17 17h.01\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":19},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.58 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83z\"\u002F>\u003Cpath d=\"M2 12a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 12\"\u002F>\u003Cpath d=\"M2 17a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 17\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":21},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M13.4 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2v-7.4M2 6h4m-4 4h4m-4 4h4m-4 4h4\"\u002F>\u003Cpath d=\"M21.378 5.626a1 1 0 1 0-3.004-3.004l-5.01 5.012a2 2 0 0 0-.506.854l-.837 2.87a.5.5 0 0 0 .62.62l2.87-.837a2 2 0 0 0 .854-.506z\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":23},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14.5 17.5L3 6V3h3l11.5 11.5M13 19l6-6m-3 3l4 4m-1 1l2-2M14.5 6.5L18 3h3v3l-3.5 3.5M5 14l4 4m-2-1l-3 3m-1-1l2 2\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":25},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 19h8M4 17l6-6l-6-6\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":27},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M3 5h.01M3 12h.01M3 19h.01M8 5h13M8 12h13M8 19h13\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":29},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m12 14l4-4M3.34 19a10 10 0 1 1 17.32 0\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":31},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M18 16.98h-5.99c-1.1 0-1.95.94-2.48 1.9A4 4 0 0 1 2 17c.01-.7.2-1.4.57-2\"\u002F>\u003Cpath d=\"m6 17l3.13-5.78c.53-.97.1-2.18-.5-3.1a4 4 0 1 1 6.89-4.06\"\u002F>\u003Cpath d=\"m12 6l3.13 5.73C15.66 12.7 16.9 13 18 13a4 4 0 0 1 0 8\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":33},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M15 21v-8a1 1 0 0 0-1-1h-4a1 1 0 0 0-1 1v8\"\u002F>\u003Cpath d=\"M3 10a2 2 0 0 1 .709-1.528l7-6a2 2 0 0 1 2.582 0l7 6A2 2 0 0 1 21 10v9a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":35},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"7\" height=\"7\" x=\"3\" y=\"3\" rx=\"1\"\u002F>\u003Crect width=\"7\" height=\"7\" x=\"14\" y=\"3\" rx=\"1\"\u002F>\u003Crect width=\"7\" height=\"7\" x=\"14\" y=\"14\" rx=\"1\"\u002F>\u003Crect width=\"7\" height=\"7\" x=\"3\" y=\"14\" rx=\"1\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":37},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12.586 2.586A2 2 0 0 0 11.172 2H4a2 2 0 0 0-2 2v7.172a2 2 0 0 0 .586 1.414l8.704 8.704a2.426 2.426 0 0 0 3.42 0l6.58-6.58a2.426 2.426 0 0 0 0-3.42z\"\u002F>\u003Ccircle cx=\"7.5\" cy=\"7.5\" r=\".5\" fill=\"currentColor\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":39},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M15 18h-5m8-4h-8m-6 8h16a2 2 0 0 0 2-2V4a2 2 0 0 0-2-2H8a2 2 0 0 0-2 2v16a2 2 0 0 1-4 0v-9a2 2 0 0 1 2-2h2\"\u002F>\u003Crect width=\"8\" height=\"4\" x=\"10\" y=\"6\" rx=\"1\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":41},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14.106 5.553a2 2 0 0 0 1.788 0l3.659-1.83A1 1 0 0 1 21 4.619v12.764a1 1 0 0 1-.553.894l-4.553 2.277a2 2 0 0 1-1.788 0l-4.212-2.106a2 2 0 0 0-1.788 0l-3.659 1.83A1 1 0 0 1 3 19.381V6.618a1 1 0 0 1 .553-.894l4.553-2.277a2 2 0 0 1 1.788 0zm.894.211v15M9 3.236v15\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":43},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14 2v6a2 2 0 0 0 .245.96l5.51 10.08A2 2 0 0 1 18 22H6a2 2 0 0 1-1.755-2.96l5.51-10.08A2 2 0 0 0 10 8V2M6.453 15h11.094M8.5 2h7\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":45},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M5 12h14m-7-7l7 7l-7 7\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":47},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 5v16m8.001-2A2 2 0 0 0 22 17V5a2 2 0 0 0-1.999-2L16 3.002A5 5 0 0 0 12 5a5 5 0 0 0-4-2H4a2 2 0 0 0-2 2v12a2 2 0 0 0 1.999 2H8a5 5 0 0 1 4 2a5 5 0 0 1 4-2z\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":49},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m9 18l6-6l-6-6\"\u002F>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":51},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"\u002F>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"\u002F>\u003C\u002Fg>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":53},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"20\" height=\"14\" x=\"2\" y=\"3\" rx=\"2\"\u002F>\u003Cpath d=\"M8 21h8m-4-4v4\"\u002F>\u003C\u002Fg>",{"id":55,"title":56,"body":57,"description":338,"extension":339,"eyebrow":340,"hostedOnly":6,"meta":341,"navigation":342,"path":343,"seo":344,"short":345,"stem":346,"__hash__":347},"docs\u002Fdocs\u002Fincludes.md","Includes (?with=)",{"type":58,"value":59,"toc":332},"minimark",[60,78,88,93,96,102,106,146,149,153,156,285,297,301,328],[61,62,63,64,68,69,73,74,77],"p",{},"A Chronicler read endpoint returns a ",[65,66,67],"strong",{},"stable base",": enough of a resource for any consumer, and no more. It never fattens itself to fit one screen. When you need extra, derived data, you ask for it with the ",[70,71,72],"code",{},"?with="," query parameter, and the endpoint attaches it as a ",[65,75,76],{},"sidecar",".",[79,80,85],"pre",{"className":81,"code":83,"language":84},[82],"language-text","GET \u002Fapi\u002Fv1\u002Fchronicles\u002F{id}\u002Fresources\u002F{resourceId}?with=stats,access\n","text",[70,86,83],{"__ignoreMap":87},"",[89,90,92],"h2",{"id":91},"why-sidecars-not-a-fat-response","Why sidecars, not a fat response",[61,94,95],{},"A sidecar is computed at query time and never stored, so it cannot go stale. Keeping it off the base has two payoffs. The base response stays small and fast for the callers that do not need the extra. And a sidecar that is expensive to compute is only paid for when a caller actually asks for it.",[61,97,98,99,101],{},"Ask for several at once by comma-separating them. An unknown name is ignored rather than erroring, so adding a ",[70,100,72],{}," value never breaks an older client.",[89,103,105],{"id":104},"common-sidecars","Common sidecars",[107,108,109,122],"table",{},[110,111,112],"thead",{},[113,114,115,119],"tr",{},[116,117,118],"th",{},"Name",[116,120,121],{},"Adds",[123,124,125,136],"tbody",{},[113,126,127,133],{},[128,129,130],"td",{},[70,131,132],{},"stats",[128,134,135],{},"Computed counts about the entity, such as how many resources a chronicle holds.",[113,137,138,143],{},[128,139,140],{},[70,141,142],{},"access",[128,144,145],{},"The calling principal's own capabilities on the entity, so a UI can show or hide actions.",[61,147,148],{},"The exact set of sidecars a given endpoint supports is listed with that endpoint in the API reference.",[89,150,152],{"id":151},"a-sidecar-is-additive","A sidecar is additive",[61,154,155],{},"A sidecar never changes the base fields. It arrives as its own section of the response, alongside the base, so parsing the base does not depend on which sidecars you asked for.",[79,157,161],{"className":158,"code":159,"language":160,"meta":87,"style":87},"language-json shiki shiki-themes github-light github-dark","{\n  \"id\": \"chron_6311hvq3sgvd7vsmyxtmsh0sas\",\n  \"name\": \"The Black Company\",\n  \"stats\": {\n    \"resourceCount\": 214,\n    \"relationshipCount\": 512\n  },\n  \"access\": {\n    \"canWrite\": true,\n    \"canManageRoles\": false\n  }\n}\n","json",[70,162,163,172,189,202,211,224,235,241,249,262,273,279],{"__ignoreMap":87},[164,165,168],"span",{"class":166,"line":167},"line",1,[164,169,171],{"class":170},"sVt8B","{\n",[164,173,175,179,182,186],{"class":166,"line":174},2,[164,176,178],{"class":177},"sj4cs","  \"id\"",[164,180,181],{"class":170},": ",[164,183,185],{"class":184},"sZZnC","\"chron_6311hvq3sgvd7vsmyxtmsh0sas\"",[164,187,188],{"class":170},",\n",[164,190,192,195,197,200],{"class":166,"line":191},3,[164,193,194],{"class":177},"  \"name\"",[164,196,181],{"class":170},[164,198,199],{"class":184},"\"The Black Company\"",[164,201,188],{"class":170},[164,203,205,208],{"class":166,"line":204},4,[164,206,207],{"class":177},"  \"stats\"",[164,209,210],{"class":170},": {\n",[164,212,214,217,219,222],{"class":166,"line":213},5,[164,215,216],{"class":177},"    \"resourceCount\"",[164,218,181],{"class":170},[164,220,221],{"class":177},"214",[164,223,188],{"class":170},[164,225,227,230,232],{"class":166,"line":226},6,[164,228,229],{"class":177},"    \"relationshipCount\"",[164,231,181],{"class":170},[164,233,234],{"class":177},"512\n",[164,236,238],{"class":166,"line":237},7,[164,239,240],{"class":170},"  },\n",[164,242,244,247],{"class":166,"line":243},8,[164,245,246],{"class":177},"  \"access\"",[164,248,210],{"class":170},[164,250,252,255,257,260],{"class":166,"line":251},9,[164,253,254],{"class":177},"    \"canWrite\"",[164,256,181],{"class":170},[164,258,259],{"class":177},"true",[164,261,188],{"class":170},[164,263,265,268,270],{"class":166,"line":264},10,[164,266,267],{"class":177},"    \"canManageRoles\"",[164,269,181],{"class":170},[164,271,272],{"class":177},"false\n",[164,274,276],{"class":166,"line":275},11,[164,277,278],{"class":170},"  }\n",[164,280,282],{"class":166,"line":281},12,[164,283,284],{"class":170},"}\n",[286,287,290],"callout",{"title":288,"tone":289},"Resolved in one pass","note",[61,291,292,293,296],{},"A sidecar on a list resolves in a single batched pass, not a query per row. Asking for ",[70,294,295],{},"?with=stats"," on a page of fifty resources costs one extra resolution, not fifty, so it stays cheap to request on a list.",[89,298,300],{"id":299},"where-to-go-next","Where to go next",[302,303,304,320],"ul",{},[305,306,307,308,311,312,315,316,319],"li",{},"Every response also carries ",[70,309,310],{},"createdAt",", ",[70,313,314],{},"updatedAt",", and, for chronicle-scoped entities, ",[70,317,318],{},"chronicleId"," on the base.",[305,321,322,323,77],{},"See the design in ",[324,325,327],"a",{"href":326},"\u002Finternal\u002Farchitecture\u002Fplatform","Platform, API & deployment",[329,330,331],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":87,"searchDepth":174,"depth":174,"links":333},[334,335,336,337],{"id":91,"depth":174,"text":92},{"id":104,"depth":174,"text":105},{"id":151,"depth":174,"text":152},{"id":299,"depth":174,"text":300},"Ask an endpoint for extra, computed data with ?with=. A base response stays small and stable; sidecars add stats, access, and other derived data only when you request them.","md","Developers",{},{"title":56},"\u002Fdocs\u002Fincludes",{"title":56,"description":338},null,"docs\u002Fincludes","zyPGgI3aJjIbESn_UnROm__2rWiYfUcT3qJkLpToAHs",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":349},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"\u002F>\u003Cpath d=\"M12 16v-4m0-4h.01\"\u002F>\u003C\u002Fg>",1788784058108]