Skip to content

[HOLD-for-9.0.0][skip-runtime-e2e] docs(decisions): canonical /decisions verdict values#212

Merged
saurabhjain1592 merged 1 commit into
mainfrom
docs/decisions-canonical-vocab
Jun 12, 2026
Merged

[HOLD-for-9.0.0][skip-runtime-e2e] docs(decisions): canonical /decisions verdict values#212
saurabhjain1592 merged 1 commit into
mainfrom
docs/decisions-canonical-vocab

Conversation

@saurabhjain1592

@saurabhjain1592 saurabhjain1592 commented Jun 11, 2026

Copy link
Copy Markdown
Member

⛔ HELD — do NOT merge until the 9.0.0 release ships

Pre-release docs/example refresh for 9.0.0. The /api/v1/decisions read surface canonicalized on the platform (merged on axonflow-enterprise main, not yet released): the endpoint returns allowed|blocked|redacted|needs_approval|error and the ?decision= filter rejects the old allow|deny|require_approval with HTTP 400. This PR merges at the 9.0.0 cut alongside the held migration guide. Ready-for-review so it can be approved now.

Tracking: getaxonflow/axonflow-enterprise#2669 (follow-up to the #2668 SDK sweep). Migration guide: getaxonflow/axonflow-docs#554.

What this changes (docs / examples / fixtures only — no logic or type change)

  • axonflow/decisions.pyDecisionExplanation.decision, DecisionSummary.decision field comments + the ListDecisionsOptions.decision filter docstring → canonical set, with a pointer to the v8→v9 migration guide.
  • examples/list_decisions.py — the AXONFLOW_LIST_DECISION env-var doc → canonical values (notes the old values now 400).
  • tests/test_decisions.pydecision-verdict fixtures/asserts and the filter-serialization mock URLs → canonical, kept in sync and green.

Explicitly NOT touched (different, unchanged surfaces)

  • The wire /api/v1/decide verdict (allow|deny|needs_approval) and the pre-check response decision field — frozen PEP enforcement contract.
  • The workflow-control / WCP gate decision (allow|block|require_approval in workflow.py / execution.py, e.g. PendingApproval.decision in test_wcp_approvals.py) — a separate surface, not the audit read; left as-is.
  • ExplainPolicy.action (policy-action vocab) and reason strings.

Validation

  • Full unit suite green: 1039 passed, 29 skipped, coverage 82% (gate 75%).
  • Repo grep is clean of stale /decisions verdict values (only the intentional migration-reference text remains).
  • DCO signed; conventional title; no AI attribution.

Skip-runtime-e2e justification

Docs / examples / test-fixtures only — no runtime behavior or wire change. The SDK forwards the /decisions ?decision= filter string verbatim (no client-side validation), so there is nothing new to exercise against a live stack: this updates docstrings, the list_decisions example env-var doc, and test fixtures from the pre-9.0.0 allow|deny|require_approval vocabulary to the canonical allowed|blocked|redacted|needs_approval|error. Fully covered by the in-repo unit/contract tests (all green locally). Held for the 9.0.0 release.

@saurabhjain1592 saurabhjain1592 force-pushed the docs/decisions-canonical-vocab branch from 4547be0 to 24e1f3c Compare June 11, 2026 15:33
@saurabhjain1592 saurabhjain1592 changed the title [HOLD-for-9.0.0] docs(decisions): canonical /decisions verdict values [HOLD-for-9.0.0][skip-runtime-e2e] docs(decisions): canonical /decisions verdict values Jun 11, 2026
The /api/v1/decisions read surface canonicalized in platform 9.0.0:
the endpoint returns allowed|blocked|redacted|needs_approval|error and
the ?decision= filter rejects the old allow|deny|require_approval with
HTTP 400. The SDK code is a string passthrough and is unaffected, but
the list_decisions / explain_decision docstrings, the example env-var
docs, and the test fixtures used the pre-9.0.0 values. Update them to
the canonical set and add a pointer to the v8 to v9 migration guide.

Docs/examples/fixtures only — no type or logic change. The wire /decide
verdict (allow|deny|needs_approval) and the workflow-control gate
decision (allow|block|require_approval) are deliberately untouched.

Held for the 9.0.0 release.

Signed-off-by: Saurabh Jain <saurabh.jain@getaxonflow.com>
@saurabhjain1592 saurabhjain1592 force-pushed the docs/decisions-canonical-vocab branch from 24e1f3c to 8020776 Compare June 11, 2026 15:37
@saurabhjain1592 saurabhjain1592 merged commit 35e3cce into main Jun 12, 2026
17 checks passed
@saurabhjain1592 saurabhjain1592 deleted the docs/decisions-canonical-vocab branch June 12, 2026 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant