v1

latestOpenAPI 3.0.2Apache 2.02026-07-13444463.0 KB
test

Create a new Test

post/tests

Request body

serviceIdstring required

Unique identifier of service to test

testEndpointstring required

Endpoint to test for this service

runnerType'HTTP' | 'SOAP_HTTP' | 'SOAP_UI' | 'POSTMAN' | 'OPEN_API_SCHEMA' | 'ASYNC_API_SCHEMA' | 'GRPC_PROTOBUF' | 'GRAPHQL_SCHEMA' required

Type of test strategy (different strategies are implemented by different runners)

timeoutinteger required

The maximum time (in milliseconds) to wait for this test ends

filteredOperationsstring[]

A restriction on service operations to test

operationHeadersOperationHeaders

Specification of additional headers for a Service/API operations. Keys are operation name or "globals" (if header applies to all), values are Header objects DTO.

secretNamestring

The name of Secret to use for connecting the test endpoint

Response

Created TestResult (empty shell cause tests are executed asynchronously)

idstring required

Unique identifier of TestResult

versionnumber required

Revision number of this test

testNumbernumber required

Incremental number for tracking number of tests of a service

testDateinteger required

Timestamp of creation date of this service

testedEndpointstring required

Endpoint used during test

serviceIdstring required

Unique identifier of service tested

elapsedTimenumber

Elapsed time in milliseconds since test beginning

successboolean required

Flag telling if test is a success

inProgressboolean required

Flag telling is test is still in progress

runnerType'HTTP' | 'SOAP_HTTP' | 'SOAP_UI' | 'POSTMAN' | 'OPEN_API_SCHEMA' | 'ASYNC_API_SCHEMA' | 'GRPC_PROTOBUF' | 'GRAPHQL_SCHEMA' required

Type of test strategy (different strategies are implemented by different runners)

operationHeadersOperationHeaders

Specification of additional headers for a Service/API operations. Keys are operation name or "globals" (if header applies to all), values are Header objects DTO.

timeoutinteger

The maximum time (in milliseconds) to wait for this test ends