[HOLD-for-9.0.0][skip-runtime-e2e] docs(decisions): canonical /decisions verdict values#192
Merged
Merged
Conversation
saurabhjain1592
force-pushed
the
docs/decisions-canonical-vocab
branch
from
dca9663 to
470e52a
Compare
saurabhjain1592
changed the title
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
force-pushed
the
docs/decisions-canonical-vocab
branch
from
470e52a to
ac3d799
Compare
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
1 participant
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.
⛔ HELD — do NOT merge until the 9.0.0 release ships
Pre-release docs/example refresh for 9.0.0. The
/api/v1/decisionsread surface canonicalized on the platform (merged onaxonflow-enterprisemain, not yet released): the endpoint returnsallowed|blocked|redacted|needs_approval|errorand the?decision=filter rejects the oldallow|deny|require_approvalwith 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)
DecisionSummary.java+DecisionExplanation.javagetDecision()Javadoc +ListDecisionsOptions.javafilter doc → canonical, with the migration-guide pointer.examples/list-decisions/.../ListDecisions.java— theAXONFLOW_LIST_DECISIONenv-var doc → canonical values.ListDecisionsTest.java+DecisionExplainTest.java—decision-verdict fixtures/asserts + wiremock query-param stubs → canonical, kept green.Explicitly NOT touched (different, unchanged surfaces)
/api/v1/decideverdict (allow|deny|needs_approval) and the pre-check responsedecisionfield — frozen PEP enforcement contract.allow|block|require_approvalin the WCP gate typesExplainPolicypolicy-action vocab andreasonstrings.Validation
mvn testgreen (1303 tests, 0 failures, 0 errors)./decisionsverdict values (only the intentional migration-reference text remains).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, thelist_decisionsexample env-var doc, and test fixtures from the pre-9.0.0allow|deny|require_approvalvocabulary to the canonicalallowed|blocked|redacted|needs_approval|error. Fully covered by the in-repo unit/contract tests (all green locally). Held for the 9.0.0 release.