docs(arcjet): document guard error/warning model in guard references#21
Open
qw-in wants to merge 1 commit into
Open
docs(arcjet): document guard error/warning model in guard references#21qw-in wants to merge 1 commit into
qw-in wants to merge 1 commit into
Conversation
Add an "Errors vs warnings (failing open)" section to the JS and Python guard references covering the new decision API: * hasFailedOpen() / has_failed_open() — the fail-closed gate (ALLOW only because a rule or the decision could not be processed) * errorResults() / error_results() — the errored results, for logging * warnings — request-validation diagnostics that never change the conclusion Version-gated: available from @arcjet/guard 1.6.0 and arcjet 0.9.0. hasError() / has_error() is deprecated from those versions (it conflated request diagnostics with rule errors). Guidance tells the agent to check the installed package's types and prefer hasFailedOpen when present. Co-Authored-By: Claude <noreply@anthropic.com>
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.
Add an "Errors vs warnings (failing open)" section to the JS and Python guard references covering the new decision API:
Version-gated: available from @arcjet/guard 1.6.0 and arcjet 0.9.0. hasError() / has_error() is deprecated from those versions (it conflated request diagnostics with rule errors). Guidance tells the agent to check the installed package's types and prefer hasFailedOpen when present.