Skip to main content

TraceTest (0.2.1)

Download OpenAPI specification:Download

OpenAPI definition for TraceTest endpoint and resources

api

Execute a definition

Execute a definition

Request Body schema: text/json
object (RunInformation)
content
string

Responses

Request samples

Content type
text/json
{
  • "runInformation": {
    },
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "runId": "string",
  • "type": "string",
  • "url": "string"
}

Upsert a definition

Upsert a definition

Request Body schema: text/json
object (RunInformation)
content
string

Responses

Request samples

Content type
text/json
{
  • "runInformation": {
    },
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Get transactions

get transactions

query Parameters
take
integer
Default: 20

indicates how many transactions can be returned by each page

skip
integer
Default: 0

indicates how many transactions will be skipped when paginating

query
string

query to search transactions, based on transaction name and description

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

indicates the sort field for the transactions

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the transactions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new transaction

Create new transaction

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

version number of the test

Array of objects (Test)
createdAt
string <date-time>
object (TestSummary)

Responses

Request samples

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

Response samples

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

get transaction

get transaction

path Parameters
transactionId
required
string

Responses

Response samples

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

update transaction

update transaction action

path Parameters
transactionId
required
string
Request Body schema: application/json
name
string
description
string
version
integer

version number of the test

Array of objects (Test)
createdAt
string <date-time>
object (TestSummary)

Responses

Request samples

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

delete a transaction

delete a transaction

path Parameters
transactionId
required
string

Responses

get a transaction specific version

get a transaction specific version

path Parameters
transactionId
required
string
version
required
integer

Responses

Response samples

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

Get the transaction definition as an YAML file

Get the transaction as an YAML file

path Parameters
transactionId
required
string
version
required
integer

Responses

run transaction

run a particular transaction

path Parameters
transactionId
required
string
Request Body schema: application/json
object or null
environmentId
string
Array of objects (EnvironmentValue)

Responses

Request samples

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

Response samples

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

Get all runs from a particular transaction

Get all runs from a particular transaction

path Parameters
transactionId
required
string
query Parameters
take
integer
Default: 20

indicates how many results can be returned by each page

skip
integer
Default: 0

indicates how many results will be skipped when paginating

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific run from a particular transaction

Get a specific run from a particular transaction

path Parameters
transactionId
required
string
runId
required
integer

Responses

Response samples

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

Delete a specific run from a particular transaction

Delete a specific run from a particular transaction

path Parameters
transactionId
required
string
runId
required
integer

Responses

Get tests

get tests

query Parameters
take
integer
Default: 20

indicates how many tests can be returned by each page

skip
integer
Default: 0

indicates how many tests will be skipped when paginating

query
string

query to search tests, based on test name and description

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

indicates the sort field for the tests

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the tests

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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)
object (TestSpecs)
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",
  • "serviceUnderTest": {
    },
  • "specs": {
    },
  • "outputs": [
    ],
  • "summary": { }
}

Response samples

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

get test

get test

path Parameters
testId
required
string

Responses

Response samples

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

update test

update test action

path Parameters
testId
required
string
Request Body schema: application/json
name
string
description
string
version
integer

version number of the test

createdAt
string <date-time>
object (Trigger)
object (TestSpecs)
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",
  • "serviceUnderTest": {
    },
  • "specs": {
    },
  • "outputs": [
    ],
  • "summary": { }
}

delete a test

delete a test

path Parameters
testId
required
string

Responses

run test

run a particular test

path Parameters
testId
required
string
Request Body schema: application/json
object or null
environmentId
string
Array of objects (EnvironmentValue)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "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",
  • "environment": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "outputs": [
    ],
  • "metadata": {
    },
  • "transactionId": "string",
  • "transactionRunId": "string"
}

get the runs for a test

get the runs from a particular test

path Parameters
testId
required
string
query Parameters
take
integer
Default: 20

indicates how many results can be returned by each page

skip
integer
Default: 0

indicates how many results will be skipped when paginating

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieve spans that will be selected by selector

get the spans ids that would be selected by a specific selector query

path Parameters
testId
required
string
runId
required
string
query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "selector": {
    },
  • "spanIds": [
    ]
}

run given assertions against the traces from the given run without persisting anything

use this method to test a definition against an actual trace without creating a new version or persisting anything

path Parameters
testId
required
string
runId
required
string
Request Body schema: application/json
Array of objects
Array
name
string or null
object (Selector)
assertions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "specs": [
    ]
}

Response samples

Content type
application/json
{
  • "allPassed": true,
  • "results": [
    ]
}

rerun a test run

rerun a test run

path Parameters
testId
required
string
runId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "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",
  • "environment": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "outputs": [
    ],
  • "metadata": {
    },
  • "transactionId": "string",
  • "transactionRunId": "string"
}

get test run results in JUnit xml format

get test run results in JUnit xml format

path Parameters
testId
required
string
runId
required
string

Responses

export test and test run information

export test and test run information for debugging

path Parameters
testId
required
string
runId
required
string

Responses

Response samples

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

import test and test run information

import test and test run information for debugging

Request Body schema: application/json
required
object (Test)
required
object (TestRun)

Responses

Request samples

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

Response samples

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

get test Run

get a particular test Run

path Parameters
testId
required
string
runId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "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",
  • "environment": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "outputs": [
    ],
  • "metadata": {
    },
  • "transactionId": "string",
  • "transactionRunId": "string"
}

delete a test run

delete a test run

path Parameters
testId
required
string
runId
required
string

Responses

Get definition for a test

Gets definition for a test

path Parameters
testId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a test specific version

get a test specific version

path Parameters
testId
required
string
version
required
integer

Responses

Response samples

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

Get the test definition as an YAML file

Get the test definition as an YAML file

path Parameters
testId
required
string
version
required
integer

Responses

Get Environments

Get Environments

query Parameters
take
integer
Default: 20

indicates how many environments can be returned by each page

skip
integer
Default: 0

indicates how many environments will be skipped when paginating

query
string

query to search environments, based on environments name and description

sortBy
string
Enum: "created" "name"

indicates the sort field for the environments

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the environments

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new environment

Create new environment action

Request Body schema: application/json
name
string
description
string
Array of objects (EnvironmentValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

get environment

get environment

path Parameters
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

update environment

update environment action

path Parameters
environmentId
required
string
Request Body schema: application/json
name
string
description
string
Array of objects (EnvironmentValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

delete a environment

delete a environment

path Parameters
environmentId
required
string

Responses

Get the environment definition as an YAML file

Get the environment as an YAML file

path Parameters
environmentId
required
string

Responses

resolves an expression and returns the result string

resolves an expression and returns the result string

Request Body schema: application/json
expression
string
object (ResolveContext)

Responses

Request samples

Content type
application/json
{
  • "expression": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "resolvedValues": [
    ]
}

Get resources

get resources

query Parameters
take
integer
Default: 20

indicates how many transactions can be returned by each page

skip
integer
Default: 0

indicates how many transactions will be skipped when paginating

query
string

query to search transactions, based on transaction name and description

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

indicates the sort field for the transactions

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the transactions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tests the config data store/exporter connection

Tests the config data store/exporter connection

Request Body schema: text/json
name
required
string
type
required
string (SupportedDataStores)
Enum: "jaeger" "openSearch" "tempo" "signalFx" "otlp" "elasticApm" "newRelic" "lightstep"
isDefault
boolean
object (GRPCClientSettings)
object (GRPCClientSettings)
object (ElasticSearch)
object (ElasticSearch)
object (SignalFX)
createdAt
string <date-time>

Responses

Request samples

Content type
text/json
{
  • "name": "string",
  • "type": "jaeger",
  • "isDefault": true,
  • "jaeger": {
    },
  • "tempo": {
    },
  • "openSearch": {
    },
  • "elasticApm": {
    },
  • "signalFx": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "successful": true,
  • "steps": [
    ]
}

Get all Data Stores

Get all Data Stores

query Parameters
take
integer
Default: 20

indicates how many data stores can be returned by each page

skip
integer
Default: 0

indicates how many data stores will be skipped when paginating

query
string

query to search data stores, based on data store name

sortBy
string
Enum: "created" "name"

indicates the sort field for the data stores

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the data stores

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Data Store

Create a new Data Store

Request Body schema: application/json
name
required
string
type
required
string (SupportedDataStores)
Enum: "jaeger" "openSearch" "tempo" "signalFx" "otlp" "elasticApm" "newRelic" "lightstep"
isDefault
boolean
object (GRPCClientSettings)
object (GRPCClientSettings)
object (ElasticSearch)
object (ElasticSearch)
object (SignalFX)
createdAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "jaeger",
  • "isDefault": true,
  • "jaeger": {
    },
  • "tempo": {
    },
  • "openSearch": {
    },
  • "elasticApm": {
    },
  • "signalFx": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "jaeger",
  • "isDefault":