Regenerate the API reference against v0.10 items 1 to 5

[arpanghoshal]

The fix for the docs check that is red on CTRLRun/ctrlrun #175 to #179.

What drifted, and why

Items 1 to 5 changed docstrings and moved line numbers, so the generated API pages no longer match
the library. 19 pages, 23 lines: line numbers, plus four signatures that gained a parameter.

Name	Gained
Control.__init__	upstream (§4.3: the surface holding the connection is the one that can name it)
protect, Control.execute, Control.evaluate	hop
Receipt	hop (ctrlrun.receipt/v7)
AuthorityResult	hop

No page was added or removed, and that is correct rather than an omission.
narrowed_dimensions and unmatched_shape are in ctrlrun.authority.__all__ and not in
ctrlrun.__all__, which is where render_api.py takes its names from — and contained_dimension
and DIMENSIONS sit in exactly that position with no pages either. Control.hop is a method and
renders inside Control.mdx.

All seven generators are clean against the stack: capabilities, cli, schemas, api,
cookbook, readiness, badges.

Merge order, because there is a circular dependency and it is worth stating

This repository's CI audits these pages against CTRLRun/ctrlrun's default branch, and
ctrlrun's docs job audits its source against this repository's default branch. So:

1. Merge the ctrlrun stack first — #175, #176, #177, #178, #179, bottom-up. Every
   required check (check (3.11), check (3.12), package) is green on all five; docs is
   advisory and stays red through the stack.
2. Then merge this PR. Its own CI only passes once ctrlrun's main carries items 1 to 5.
3. ctrlrun's docs job then goes green on main.

A five-PR stack cannot all be docs-green at once, because the generated pages are a function of
one source state: pages matching the full stack necessarily differ from #175's source, which has
none of the items. That is a property of the split-repo audit, not something this PR can work
around.

Summary by CodeRabbit

• Documentation
  • Updated API reference links so documented definitions point to their current source locations.
  • Documented new optional hop parameters for relevant authority and protection APIs.
  • Documented the optional upstream parameter for controls.
  • Clarified the reconciliation callback type in the protection API reference.
  • Refreshed formatting and signature details across the API documentation.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
ctrlrun	🟢 Ready	View Preview	Sep 13, 2026, 6:39 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 67243cff-5e81-4caa-b0be-65e797c3bf99

📥 Commits

Reviewing files that changed from the base of the PR and between 351ef20 and c37c2d1.

📒 Files selected for processing (19)

• docs/reference/api/Authority.mdx
• docs/reference/api/AuthorityResult.mdx
• docs/reference/api/Condition.mdx
• docs/reference/api/Control.mdx
• docs/reference/api/Decision.mdx
• docs/reference/api/Delegation.mdx
• docs/reference/api/Event.mdx
• docs/reference/api/EventSink.mdx
• docs/reference/api/Grant.mdx
• docs/reference/api/JSONLEventSink.mdx
• docs/reference/api/Policy.mdx
• docs/reference/api/Receipt.mdx
• docs/reference/api/Subject.mdx
• docs/reference/api/authority-Budget.mdx
• docs/reference/api/context.mdx
• docs/reference/api/idempotency_token.mdx
• docs/reference/api/parse_conditions.mdx
• docs/reference/api/protect.mdx
• docs/reference/api/with_approval.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The API reference pages update source-definition links and document signature changes for AuthorityResult, Control, and protect. The Receipt signature content remains unchanged.

Changes

API reference synchronization

Layer / File(s)	Summary
Source location updates docs/reference/api/*.mdx	The reference pages update source line links for classes and functions across the authority, control, policy, and receipt modules.
Signature reference updates docs/reference/api/AuthorityResult.mdx, docs/reference/api/Control.mdx, docs/reference/api/protect.mdx, docs/reference/api/Receipt.mdx	The documentation adds hop to AuthorityResult.__init__ and protect, adds upstream to Control.__init__, updates the protect reconcile type, and preserves the Receipt.__init__ signature content.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to c37c2

This documentation-only synchronization is ready to merge with no identified user or production impact.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: regenerating the API reference for v0.10 items 1 through 5.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch release/0.10.0-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[arpanghoshal]

Superseded. This branch was regenerated against the whole v0.10 stack, so it could not be green against the kernel's main until every item merged, and the kernel's runs could not be green against this repository's main until this merged: each side waiting for the other. The replacement is one branch here per kernel branch, named the same, each checked against the other by the CI change in #15: #15 (CI rule plus items 1 and 2, already on the kernel's main), #16 (item 3, G27), #17 (item 4), and v0.10/5-operator-surfaces pushed without a PR because item 5 changes no page. Merge order follows the kernel's. The branch is left in place.