Rules

Analyze rule-set interactions and configuration impact

Check the current or proposed rule configuration for potential interactions between rules.

post/v1/programs/{program_id}/rule-configuration/analysis

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/programs/{program_id}/rule-configuration/analysis
  • Auth: HTTP bearer

Path parameters

program_idstring uuid required

The program's id.

Request body

proposed_configurationPreviewRuleConfigurationRequest (unresolved $ref)

Response

The findings for the analyzed configuration

active_rule_countinteger

ACTIVE rules participating in runtime interaction analysis.

base_rule_configuration_versioninteger

Current configuration version used as the basis for the analysis.

configuration_hashstring

Stable SHA-256 hash of the analyzed current configuration or normalized proposal.

finding_countinteger

Number of findings returned.

program_idstring uuid

Program whose configuration was analyzed.

rule_countinteger

Total ACTIVE and SUSPENDED rules in the analyzed configuration.

source'current' | 'proposed'

Configuration source: current or proposed.

truncatedboolean

True when the response limit prevented some findings from being returned.

Example response

{
  "findings": [
    {
      "code": "duplicate_reward_effect",
      "confidence": "likely",
      "message": "equivalent matching rules repeat the same ledger reward effect",
      "remediation": "Remove one effect, make the conditions mutually exclusive, or place alternatives in one set with an explicit set-local stop.",
      "runtime_semantics": "Every ACTIVE rule set participates. Identical conditions in different sets both match; set order does not select or replace one set.",
      "severity": "warning"
    }
  ],
  "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01"
}

Changes

No recorded changes to this operation across all 1 revision of this API.