Manage Assertions

A dedicated assertion CRUD surface for REST request steps, independent of the healing workflow in Group 5. Use this group when you want direct, manual control over what a step checks. For assertion changes driven by a spec update, use Group 5.

Supported assertion types across all tools in this group: VALID_HTTP_STATUS_CODES, CONTAINS, NOT_CONTAINS, GROOVY_SCRIPT, RESPONSE_SLA, SCHEMA_COMPLIANCE.

Version 1.2.0: consolidated tools

Version 1.2.0 consolidates the assertion list, find, and delete tools in this group into three parameterized tools. For the full mapping of old tool names to new calls, see the table below.

list READ

Lists every assertion on a step, with type and enabled state. Names are case-insensitive.

Key parameters:

  • kind: "assertion"*

  • ref* - { projectName, testSuiteName, testCaseName, testStepName }

Try asking your AI client: "What assertions are on the Submit Order step?"

describe READ

Finds a single named assertion of a given type and returns its full configuration. Names are case-insensitive. Errors: NOT_FOUND, CLOSED, or No <entity> named <name>.

Key parameters:

  • kind: "assertion"*

  • ref* - { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName }

Try asking your AI client: "Show me the response SLA assertion on Submit Order."

delete WRITE

Deletes a named assertion from a step. Names are case-insensitive. Errors: NOT_FOUND, CLOSED, or No <entity> named <name>.

Key parameters:

  • kind: "assertion"*

  • ref* - { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName }

Try asking your AI client: "Remove the schema compliance assertion from Submit Order."

* Required parameter.

ref examples

list("assertion",    { projectName, testSuiteName, testCaseName, testStepName })
describe("assertion",{ projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName })
delete("assertion",  { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName })
    
Table 120. Table 4b. Superseded manage assertions tools

Version 1.1.0 tool

Version 1.2.0 equivalent

assertion_list_all

list("assertion", { projectName, testSuiteName, testCaseName, testStepName })

assertion_find_one

describe("assertion", { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName })

assertion_delete

delete("assertion", { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName })



Version 1.1.0: individual tools

assertion_add WRITE

Adds a new assertion to a REST request step. Supply type-specific parameters: codes for VALID_HTTP_STATUS_CODES; slaValue (ms) for RESPONSE_SLA; scriptText for GROOVY_SCRIPT; searchString, ignoreCase, useRegex for CONTAINS and NOT_CONTAINS; schemaUrl and strictMode for SCHEMA_COMPLIANCE.

Key parameters:

  • projectName*, suiteName*, caseName*, stepName*, assertionType* — optional: assertionName, type-specific parameters

Try asking your AI client: "Add an assertion to Submit Order that the response status is 200 or 201."

assertion_modify WRITE

Updates one or more properties of an existing assertion. Supply only the parameters you want to change.

Key parameters:

  • projectName*, suiteName*, caseName*, stepName*, assertionType*, assertionName* - type-specific parameters

Try asking your AI client: "Update the SLA assertion on Submit Order to 800ms."

See Also

Publication date: