Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/api/Authority.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "The `authority:` section, loaded and evaluable (SPEC-v0.3 §4)."

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Authority` — class, defined at `src/ctrlrun/authority.py:1134`
`ctrlrun.Authority` — class, defined at `src/ctrlrun/authority.py:1229`

```python
from ctrlrun import Authority
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api/AuthorityResult.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "What the authority axis decided, and which grant it decided on (§

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.AuthorityResult` — class, defined at `src/ctrlrun/authority.py:619`
`ctrlrun.AuthorityResult` — class, defined at `src/ctrlrun/authority.py:621`

```python
from ctrlrun import AuthorityResult
Expand All @@ -14,7 +14,7 @@ from ctrlrun import AuthorityResult

```python
class AuthorityResult
def __init__(passed: bool, reason: str, grant_id: str | None = None, delegation_id: str | None = None, depth: int = 0, dimension: str | None = None, missing_parent_id: str | None = None, expired_parent_id: str | None = None, depth_exceeded: int | None = None, cycle_at: str | None = None)
def __init__(passed: bool, reason: str, grant_id: str | None = None, delegation_id: str | None = None, depth: int = 0, hop: str | None = None, dimension: str | None = None, missing_parent_id: str | None = None, expired_parent_id: str | None = None, depth_exceeded: int | None = None, cycle_at: str | None = None)
```

What the authority axis decided, and which grant it decided on (§4.8).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Condition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "One `<argument>_<op>: operand` test against an action's arguments

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Condition` — class, defined at `src/ctrlrun/policy.py:371`
`ctrlrun.Condition` — class, defined at `src/ctrlrun/policy.py:398`

```python
from ctrlrun import Condition
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api/Control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Policy, state and evidence composed around a single action (SPEC-v

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Control` — class, defined at `src/ctrlrun/control.py:677`
`ctrlrun.Control` — class, defined at `src/ctrlrun/control.py:825`

```python
from ctrlrun import Control
Expand All @@ -14,7 +14,7 @@ from ctrlrun import Control

```python
class Control
def __init__(policy: Policy, store: StateStore, approvals: ApprovalProvider | None = None, *, clock: Callable[[], datetime] = _utc_now, approval_ttl: timedelta = DEFAULT_APPROVAL_TTL, lease: timedelta = DEFAULT_LEASE, sinks: Sequence[EventSink] = (), suspend_timeout: timedelta = DEFAULT_SUSPEND_TIMEOUT, identity: IdentityProvider | None = None, authority: Authority | None = None, environment: str | None = None, approver_identity: ApproverIdentity | None = None, require_approved_policy: bool = False)
def __init__(policy: Policy, store: StateStore, approvals: ApprovalProvider | None = None, *, clock: Callable[[], datetime] = _utc_now, approval_ttl: timedelta = DEFAULT_APPROVAL_TTL, lease: timedelta = DEFAULT_LEASE, sinks: Sequence[EventSink] = (), suspend_timeout: timedelta = DEFAULT_SUSPEND_TIMEOUT, identity: IdentityProvider | None = None, authority: Authority | None = None, environment: str | None = None, approver_identity: ApproverIdentity | None = None, require_approved_policy: bool = False, upstream: str | None = None)
```

Policy, state and evidence composed around a single action (SPEC-v0.1 §8).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Decision.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "What may happen to an action: exactly three outcomes in v0.1 (SPEC

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Decision` — class, defined at `src/ctrlrun/policy.py:308`
`ctrlrun.Decision` — class, defined at `src/ctrlrun/policy.py:335`

```python
from ctrlrun import Decision
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Delegation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "A grant created at runtime by a principal who already holds one (S

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Delegation` — class, defined at `src/ctrlrun/authority.py:579`
`ctrlrun.Delegation` — class, defined at `src/ctrlrun/authority.py:581`

```python
from ctrlrun import Delegation
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "One ordered step in the life of an action (SPEC-v0.1 §6.2)."

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Event` — class, defined at `src/ctrlrun/receipt.py:297`
`ctrlrun.Event` — class, defined at `src/ctrlrun/receipt.py:305`

```python
from ctrlrun import Event
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/EventSink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Somewhere a copy of every `Event` and `Receipt` goes (SPEC-v0.2 §

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.EventSink` — class, defined at `src/ctrlrun/receipt.py:773`
`ctrlrun.EventSink` — class, defined at `src/ctrlrun/receipt.py:798`

```python
from ctrlrun import EventSink
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Grant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "One permission: this subject may propose these actions, under thes

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Grant` — class, defined at `src/ctrlrun/authority.py:416`
`ctrlrun.Grant` — class, defined at `src/ctrlrun/authority.py:431`

```python
from ctrlrun import Grant
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/JSONLEventSink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "The JSONL half of the evidence: two append-only files in one direc

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.JSONLEventSink` — class, defined at `src/ctrlrun/receipt.py:792`
`ctrlrun.JSONLEventSink` — class, defined at `src/ctrlrun/receipt.py:817`

```python
from ctrlrun import JSONLEventSink
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Action-level autonomy policy: which actions may run, and under whi

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Policy` — class, defined at `src/ctrlrun/policy.py:700`
`ctrlrun.Policy` — class, defined at `src/ctrlrun/policy.py:759`

```python
from ctrlrun import Policy
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api/Receipt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Portable evidence of one action that reached a terminal state (SPE

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Receipt` — class, defined at `src/ctrlrun/receipt.py:389`
`ctrlrun.Receipt` — class, defined at `src/ctrlrun/receipt.py:397`

```python
from ctrlrun import Receipt
Expand All @@ -14,7 +14,7 @@ from ctrlrun import Receipt

```python
class Receipt
def __init__(receipt_id: str, action_id: str, action: str, action_hash: str, principal: Principal, resource: str | None, arguments: Mapping[str, Any], environment: str, decision: Decision, decision_reason: str, result: ReceiptResult, started_at: datetime, finished_at: datetime, approval_id: str | None = None, approver: str | None = None, effect_key: str | None = None, attempt: int = 1, error: str | None = None, execution: ReceiptResult | None = None, would_have: _WouldHave | None = None, seq: int | None = None, prev_hash: str | None = None, policy_hash: str | None = None, policy_version: str | None = None, controls: tuple[str, ...] = (), hash: str | None = None, precondition_at_request: str | None = None, precondition_at_recheck: str | None = None, approvers: tuple[VerifiedApprover, ...] = (), authority_grant_id: str | None = None, task: str | None = None, scope_hash: str | None = None, budget_charges: tuple[Mapping[str, Any], ...] = (), schema: str = RECEIPT_SCHEMA)
def __init__(receipt_id: str, action_id: str, action: str, action_hash: str, principal: Principal, resource: str | None, arguments: Mapping[str, Any], environment: str, decision: Decision, decision_reason: str, result: ReceiptResult, started_at: datetime, finished_at: datetime, approval_id: str | None = None, approver: str | None = None, effect_key: str | None = None, attempt: int = 1, error: str | None = None, execution: ReceiptResult | None = None, would_have: _WouldHave | None = None, seq: int | None = None, prev_hash: str | None = None, policy_hash: str | None = None, policy_version: str | None = None, controls: tuple[str, ...] = (), hash: str | None = None, precondition_at_request: str | None = None, precondition_at_recheck: str | None = None, approvers: tuple[VerifiedApprover, ...] = (), authority_grant_id: str | None = None, task: str | None = None, scope_hash: str | None = None, hop: str | None = None, budget_charges: tuple[Mapping[str, Any], ...] = (), schema: str = RECEIPT_SCHEMA)
```

Portable evidence of one action that reached a terminal state (SPEC-v0.1 §6.1).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/Subject.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Who a grant is addressed to: an agent pattern, a user pattern, or

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.Subject` — class, defined at `src/ctrlrun/authority.py:320`
`ctrlrun.Subject` — class, defined at `src/ctrlrun/authority.py:335`

```python
from ctrlrun import Subject
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/authority-Budget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "How much, over what, in how long (SPEC-v0.9 §2.2)."

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.authority.Budget` — class, defined at `src/ctrlrun/authority.py:366`
`ctrlrun.authority.Budget` — class, defined at `src/ctrlrun/authority.py:381`

```python
from ctrlrun.authority import Budget
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Bind the principal for calls made inside the block."

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.context` — function, defined at `src/ctrlrun/control.py:322`
`ctrlrun.context` — function, defined at `src/ctrlrun/control.py:368`

```python
from ctrlrun import context
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/idempotency_token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "The provider idempotency token for the attempt this executor is ru

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.idempotency_token` — function, defined at `src/ctrlrun/control.py:290`
`ctrlrun.idempotency_token` — function, defined at `src/ctrlrun/control.py:336`

```python
from ctrlrun import idempotency_token
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/parse_conditions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Parse a `when:`-shaped mapping into conditions, keyed by the raw c

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.parse_conditions` — function, defined at `src/ctrlrun/policy.py:1248`
`ctrlrun.parse_conditions` — function, defined at `src/ctrlrun/policy.py:1326`

```python
from ctrlrun import parse_conditions
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api/protect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ description: "Bind a function to an action name: every call becomes a decided, r

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.protect` — function, defined at `src/ctrlrun/control.py:4576`
`ctrlrun.protect` — function, defined at `src/ctrlrun/control.py:4902`

```python
from ctrlrun import protect
```


```python
def protect(name: str, *, effect: str | None = None, resource: str | None = None, wait: bool = False, lease: timedelta | None = None, reconcile: Callable[[str], ReconcileOutcome] | None = None, reconcile_eagerly: bool = False, control: Control | None = None, preconditions: Callable[[Action], Mapping[str, Any]] | None = None, task: str | None = None, scope: Callable[[Action], Mapping[str, Any]] | None = None) -> Callable[[Callable[P, R]], Callable[P, R]]
def protect(name: str, *, effect: str | None = None, resource: str | None = None, wait: bool = False, lease: timedelta | None = None, reconcile: Callable[[str], ReconcileOutcome] | None = None, reconcile_eagerly: bool = False, control: Control | None = None, preconditions: Callable[[Action], Mapping[str, Any]] | None = None, task: str | None = None, hop: str | None = None, scope: Callable[[Action], Mapping[str, Any]] | None = None) -> Callable[[Callable[P, R]], Callable[P, R]]
```

Bind a function to an action name: every call becomes a decided, recorded Action.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/with_approval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Present a granted approval to the calls made inside the block (SPE

{/* generated by tools/docs_audit/render_api.py from the docstrings — edit the docstring, never this page */}

`ctrlrun.with_approval` — function, defined at `src/ctrlrun/control.py:345`
`ctrlrun.with_approval` — function, defined at `src/ctrlrun/control.py:391`

```python
from ctrlrun import with_approval
Expand Down
Loading