TOM¶

Overview¶

TOM API

Version information¶

Version : 1.0.0

URI scheme¶

Host : localhost:8000
BasePath : /
Schemes : HTTP

Produces¶

application/json

Paths¶

analyze data¶

1	GET /analyze

Description¶

to order the data TOM analysis

Parameters¶

Type	Name	Description	Schema	Default
Query	input required	pasted input variables names (seperated by:). Improvement/next version -> give an array of string	string(string)	`"deploy_scenario:version:pod_name:runner_id"`
Query	output required	the output variable name	string(string)	`"bandwidth.MBps."`

Responses¶

HTTP Code	Description	Schema
200	analyzing file succeeded	< Success > array
default	Unexpected error	Error

compare different contexts¶

1	GET /comparGraph

Description¶

compare different contexts using boxplots

Parameters¶

Type	Name	Description	Schema	Default
Query	input required	pasted input variables names (seperated by:). Improvement/next version -> give an array of string	string(string)	`"deploy_scenario:version:pod_name:runner_id"`
Query	limit optional	number of contexts to limit the results on	number(integer)	`"10"`
Query	output required	the output variable name	string(string)	`"bandwidth.MBps."`

Responses¶

HTTP Code	Description	Schema
200	contexts boxplots	< Graph > array
default	Unexpected error	Error

bivariate correlations¶

1	GET /correlation

Description¶

get bivariate correlations between input and output

Responses¶

HTTP Code	Description	Schema
200	correlation values	< Value > array
default	Unexpected error	Error

growing mutual correlations¶

1	GET /explain

Description¶

get growing mutual correlation values between output and subsets of input

Responses¶

HTTP Code	Description	Schema
200	mutual correlation values	< Value > array
default	Unexpected error	Error

growing mutual correlations graph¶

1	GET /explainGraph

Description¶

get growing mutual correlation values graph between output and subsets of input

Responses¶

HTTP Code	Description	Schema
200	mutual correlation values graph	< Graph > array
default	Unexpected error	Error

head contexts according to input¶

GET /head

Description¶

get head median output values of single contexts defined by input variables

Parameters¶

Type	Name	Description	Schema	Default
Query	input required	pasted input variables names (seperated by:). Improvement/next version -> give an array of string	string(string)	`"deploy_scenario:version:pod_name:runner_id"`
Query	limit optional	number of contexts to limit the results on	number(integer)	`"5"`
Query	output required	the output variable name	string(string)	`"bandwidth.MBps."`

Responses¶

HTTP Code	Description	Schema
200	mutual correlation values	< Value > array
default	Unexpected error	Error

load data¶

GET /read

Description¶

to order the data loading

Parameters¶

Type	Name	Description	Schema	Default
Query	file required	path of the file to load.	string(string)	`"examples/test_opnfv_yardstick_tc012.csv"`

Responses¶

HTTP Code	Description	Schema
200	reading file succeeded	< Success > array
default	Unexpected error	Error

tail contexts according to input¶

GET /tail

Description¶

get tail median output values of single contexts defined by input variables

Parameters¶

Type	Name	Description	Schema	Default
Query	input required	pasted input variables names (seperated by:). Improvement/next version -> give an array of string	string(string)	`"deploy_scenario:version:pod_name:runner_id"`
Query	limit optional	number of contexts to limit the results on	number(integer)	`"5"`
Query	output required	the output variable name	string(string)	`"bandwidth.MBps."`

Responses¶

HTTP Code	Description	Schema
200	mutual correlation values	< Value > array
default	Unexpected error	Error

Definitions¶

Error¶

Name	Description	Schema
code optional		integer(int32)
fields optional		string
message optional		string

Graph¶

Type : object

Success¶

Name	Description	Schema
durationInSeconds optional		string
result optional		string

Value¶

Name	Description	Schema
value optional	Value	number(double)