Skip to main content

TraceTest (0.2.1)

Download OpenAPI specification:Download

OpenAPI definition for TraceTest endpoint and resources

resource-api

Get testsuites

get testsuites

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

query
string

query to search resources

sortBy
string
Enum: "created" "name" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create new TestSuite

Create new TestSuite

Request Body schema:
type
string
Value: "TestSuite"

Represents the type of this resource. It should always be set as 'TestSuite'.

object (TestSuite)

Responses

Request samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

get TestSuite

get TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

Responses

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

update TestSuite

update TestSuite action

path Parameters
testSuiteId
required
string

id of the TestSuite

Request Body schema:
type
string
Value: "TestSuite"

Represents the type of this resource. It should always be set as 'TestSuite'.

object (TestSuite)

Responses

Request samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

delete a TestSuite

delete a TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

Responses

Get tests

get tests

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

query
string

query to search resources

sortBy
string
Enum: "created" "name" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create new test

Create new test action

Request Body schema: application/json
name
string
description
string
version
integer

version number of the test

createdAt
string <date-time>
object (Trigger)
skipTraceCollection
boolean

If true, the test will not collect a trace

Array of objects (TestSpec)

specification of assertions that are going to be made

Array of objects (TestOutput)

define test outputs, in a key/value format. The value is processed as an expression

object (TestSummary)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "trigger": {
    },
  • "skipTraceCollection": true,
  • "specs": [
    ],
  • "outputs": [
    ],
  • "summary": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "trigger": {
    },
  • "skipTraceCollection": true,
  • "specs": [
    ],
  • "outputs": [
    ],
  • "summary": {
    }
}

get test

get test

path Parameters
testId
required
string

id of the test

Responses

Response samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

update test

update test action

path Parameters
testId
required
string

id of the test

Request Body schema: application/json
name
string
description
string
version
integer

version number of the test

createdAt
string <date-time>
object (Trigger)
skipTraceCollection
boolean

If true, the test will not collect a trace

Array of objects (TestSpec)

specification of assertions that are going to be made

Array of objects (TestOutput)

define test outputs, in a key/value format. The value is processed as an expression

object (TestSummary)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "trigger": {
    },
  • "skipTraceCollection": true,
  • "specs": [
    ],
  • "outputs": [
    ],
  • "summary": { }
}

delete a test

delete a test

path Parameters
testId
required
string

id of the test

Responses

List Tracetest configuration

List Tracetest configuration

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Get Tracetest configuration

Get Tracetest configuration

path Parameters
configId
required
string

ID of the configuration resource used on Tracetest. It should be set as 'current'

Responses

Response samples

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

Update Tracetest configuration

Update Tracetest configuration

path Parameters
configId
required
string

ID of the configuration resource used on Tracetest. It should be set as 'current'

Request Body schema:
type
string
Value: "Config"

Represents the type of this resource. It should always be set as 'Config'.

object

Represents the set of configuration common options for Tracetest.

Responses

Request samples

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

List Polling Profile Configuration

List Polling Profile configuration

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Get Polling Profile

Get a polling profile used on Tracetest to configure how to fetch traces in a test.

path Parameters
pollingProfileId
required
string

ID of a polling profile used on Tracetest to configure how to fetch traces in a test. It should be set as 'current'

Responses

Response samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Update a Polling Profile

Update a polling profile used on Tracetest to configure how to fetch traces in a test.

path Parameters
pollingProfileId
required
string

ID of a polling profile used on Tracetest to configure how to fetch traces in a test. It should be set as 'current'

Request Body schema:
type
string
Value: "PollingProfile"

Represents the type of this resource. It should always be set as 'PollingProfile'.

object

Represents the attributes of a Polling Profile.

Responses

Request samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

List Demonstrations

List demonstrations used on Tracetest as quick start examples.

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create a Demonstration setting

Create a demonstration used on Tracetest as quick start examples.

Request Body schema:
type
string
Value: "Demo"

Represents the type of this resource. It should always be set as 'Demo'.

object

Represents the attributes of a Demonstration API.

Responses

Request samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Get Demonstration setting

Get a demonstration used on Tracetest as quick start examples.

path Parameters
demoId
required
string

ID of a demonstration used on Tracetest as quick start examples

Responses

Response samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Update a Demonstration setting

Update a demonstration used on Tracetest as quick start examples.

path Parameters
demoId
required
string

ID of a demonstration used on Tracetest as quick start examples

Request Body schema:
type
string
Value: "Demo"

Represents the type of this resource. It should always be set as 'Demo'.

object

Represents the attributes of a Demonstration API.

Responses

Request samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Delete a Demonstration setting

Delete a demonstration used on Tracetest as quick start examples.

path Parameters
demoId
required
string

ID of a demonstration used on Tracetest as quick start examples

Responses

List Data Store

List Data Store

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Get a Data Store

Get a Data Store

path Parameters
dataStoreId
required
string

ID of a datastore used on Tracetest to configure how to fetch traces in a test

Responses

Response samples

Content type
application/json
{
  • "type": "DataStore",
  • "spec": {
    }
}

Update a Data Store

Update a Data Store

path Parameters
dataStoreId
required
string

ID of a datastore used on Tracetest to configure how to fetch traces in a test

Request Body schema: application/json
name
required
string
type
required
string (SupportedDataStores)
Enum: "agent" "jaeger" "opensearch" "tempo" "signalfx" "otlp" "elasticapm" "newrelic" "lightstep" "datadog" "awsxray" "honeycomb" "azureappinsights" "signoz" "dynatrace"
default
boolean
object (GRPCClientSettings)
object (BaseClient)
object (ElasticSearch)
object (ElasticSearch)
object (SignalFX)
object (AwsXRay)
object (AzureAppInsights)
createdAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "agent",
  • "default": true,
  • "jaeger": {
    },
  • "tempo": {
    },
  • "opensearch": {
    },
  • "elasticapm": {
    },
  • "signalfx": {
    },
  • "awsxray": {
    },
  • "azureappinsights": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete a Data Store

Delete a Data Store

path Parameters
dataStoreId
required
string

ID of a datastore used on Tracetest to configure how to fetch traces in a test

Responses

List VariableSets

List VariableSets available in Tracetest.

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create a VariableSet

Create a VariableSet that can be used by tests and test suites

Request Body schema:
type
string
Value: "VariableSet"

Represents the type of this resource. It should always be set as 'VariableSet'.

object (VariableSet)

Responses

Request samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Get a specific VariableSet

Get one VariableSet by its id

path Parameters
variableSetId
required
string

ID of a VariableSet used on Tracetest to inject values into tests and TestSuites

Responses

Response samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Update a VariableSet

Update a VariableSet used on Tracetest

path Parameters
variableSetId
required
string

ID of a VariableSet used on Tracetest to inject values into tests and TestSuites

Request Body schema:
type
string
Value: "VariableSet"

Represents the type of this resource. It should always be set as 'VariableSet'.

object (VariableSet)

Responses

Request samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Delete a variable set

Delete a variable set from Tracetest

path Parameters
variableSetId
required
string

ID of a VariableSet used on Tracetest to inject values into tests and TestSuites

Responses

List Linters

List Linters available in Tracetest.

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

sortBy
string
Enum: "type" "enabled"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "items": [
    ]
}

Create an Linter

Create an Linter that can be used by tests and Linters

Request Body schema:
type
string
Value: "Linter"
object

Responses

Request samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Get a specific Linter

Get one Linter by its id

path Parameters
LinterId
required
string

ID of an Linter

Responses

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Update a Linter

Update a Linter used on Tracetest

path Parameters
LinterId
required
string

ID of an Linter

Request Body schema:
type
string
Value: "Linter"
object

Responses

Request samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Delete an Linter

Delete an Linter from Tracetest

path Parameters
LinterId
required
string

ID of an Linter

Responses

api

get a TestSuite specific version

get a TestSuite specific version

path Parameters
testSuiteId
required
string

id of the TestSuite

version
required
integer

version of the test

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "steps": [
    ],
  • "fullSteps": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "summary": {
    }
}

run TestSuite

run a particular TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

Request Body schema: application/json
object or null
variableSetId
string
Array of objects (VariableSetValue)
requiredGates
Array of strings or null (SupportedGates)
Enum: "analyzer-score" "analyzer-rules" "test-specs"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "variableSetId": "string",
  • "variables": [
    ],
  • "requiredGates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "state": "CREATED",
  • "steps": [
    ],
  • "variableSet": {
    },
  • "metadata": {
    },
  • "pass": 0,
  • "fail": 0,
  • "allStepsRequiredGatesPassed": true
}

Get all runs from a particular TestSuite

Get all runs from a particular TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

query Parameters
take
integer
Default: 20

indicates how many resources can be returned by each page

skip
integer
Default: 0

indicates how many resources will be skipped when paginating

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific run from a particular TestSuite

Get a specific run from a particular TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "state": "CREATED",
  • "steps": [
    ],
  • "variableSet": {
    },
  • "metadata": {
    },
  • "pass": 0,
  • "fail": 0,
  • "allStepsRequiredGatesPassed": true
}

Delete a specific run from a particular TestSuite

Delete a specific run from a particular TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

runId
required
integer

id of the run

Responses

run test

run a particular test

path Parameters
testId
required
string

id of the test

Request Body schema: application/json
object or null
variableSetId
string
Array of objects (VariableSetValue)
requiredGates
Array of strings or null (SupportedGates)
Enum: "analyzer-score" "analyzer-rules" "test-specs"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "variableSetId": "string",
  • "variables": [
    ],
  • "requiredGates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "traceId": "string",
  • "spanId": "string",
  • "testVersion": 0,
  • "state": "CREATED",
  • "lastErrorState": "string",
  • "executionTime": 0,
  • "triggerTime": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "serviceTriggeredAt": "2019-08-24T14:15:22Z",
  • "serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
  • "obtainedTraceAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "variableSet": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },