Skip to content
Ishvana Ishvana Docs

Validate Ruleset

POST
/api/creative/mechanics/rulesets/{ruleset_id}/validate

Validate a ruleset’s formulas and template references.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
ruleset_id
required
Ruleset Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

RulesetValidationResponse
object
valid
required
Valid
boolean
formulaResults
required
Formularesults
Array<object>
FormulaValidationResult
object
expression
required
Expression
string
valid
required
Valid
boolean
errors
required
Errors
Array<string>
referencedVariables
required
Referencedvariables
Array<string>
unknownVariables
required
Unknownvariables
Array<string>
errorDetails
Errordetails
Array<object>
default:
FormulaErrorDetail

Structured formula error with position info for caret display.

position is a 0-based character offset into the original expression string. length is the highlight span (defaults to 1 for caret-only). code identifies the error category so the UI can group/style.

object
code
required
Code
string
message
required
Message
string
position
Any of:
integer
length
Length
integer
default: 1
hint
Any of:
string
statErrors
required
Staterrors
Array<string>
templateErrors
required
Templateerrors
Array<string>

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object