Assertion

Overview

Assertions serve as a quality control measure ensuring the completeness and correctness of the expected data as defined in a Step.

View

In the upper left corner, select your project from the Select Project dropdown list and the version from the Version dropdown list. Only the assertions associated with the selected project and version are displayed on the left pane.

Edit an assertion

To view or modify the details of an assertion, select the assertion from the left pane that lists all assertions associated with the selected project and version. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

The search feature allows you to filter the list of assertions by providing a keyword or the full name of an assertion. Only the assertions that match the provided keyword or name will be displayed in the view.

Create an assertion

To create an assertion, click on the icon on the top left pane and enter valid values to the following fields.

Field NameDescription
Assertion Service NameName of the assertion. It should be a minimum of 5 characters long.

Mandatory: Yes
Assertion Type

Specifies the type of step. The following are the possible values:

Mandatory: Yes

Create an API assertion

To create an API assertion, enter valid values in the following fields:

Field Description
HTTP Method

Specifies the action to be performed by the external system to your server. The following are the possible values:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE


Mandatory: Yes
URL

Specifies the API URL used for the validation. It consists of 2 parts:

  • Environment — automatically displays the default environment set in the selected project. If you wish to select a different environment, click the dropdown arrow beside Send to display all environments configured within the selected project.
  • URL — specify the URL of the API service.

Mandatory: Yes
Params

Specifies the type of parameters for query execution and data retrieval. You can specify the parameters in the following ways:

  • Query Params— allows you to specify keys and their respective values for data retrieval. It can be updated by changing the URL or adding queries in the table.
  • Path Params — shows the specified keys requested for retrieval in the API URL. You can only change the key values by updating the API URL.

Mandatory: No
Body

Specifies the payload details of the assertion. You can choose between the following formats:

  • Form Data — allows you to define key-value pairs.
  • JSON — allows you to define the template of the request and response bodies.

Mandatory: No
Headers Specifies the API headers in HTTP requests or responses that provide important metadata, such as content type, authentication details, and instructions for processing the data.

Create a Query assertion

SectionDescription
SchemaSpecifies the schema of the database where the query will be executed. This is automatically populated from the configured database at the environment level and only needs to be selected at the assertion level.
QueryDefines the query being executed to get results for validation.
ParametersLists the input key-value pairs extracted from the provided query.
ResultsSpecifies the expected result after running the query.
Output ColumnsList of database columns included in the expected result after running the query, along with their data types.