saucelabs
Advanced tools
saucelabs - npm Package Compare versions
Comparing version 2.3.0 to 3.0.0
7
a.js
@@ -18,9 +18,6 @@ const SauceLabs = require('./build').default | ||
| api.getSubaccounts('cb-onboarding') | ||
| api.getPerformanceMetricsByJobId('73b1ad4e397e48cbb972e07018280260', { full: true }) | ||
| .then( | ||
| (a) => console.log('fertig', a), | ||
| (a) => console.log(JSON.stringify(a, null, 4)), | ||
| (err) => console.log('uouups', err) | ||
| ) | ||
| console.log(2); |
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Performance API", | ||
| "version": "0.94.0" | ||
| }, | ||
| "host": "api.saucelabs.com", | ||
| "basePath": "/v1/performance", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/metrics/{job_id}/": { | ||
| "get": { | ||
| "operationId": "get_performance_metrics", | ||
| "summary": "Get performance metrics of specific test.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Gets performance metrics for a given job id", | ||
| "schema": { | ||
| "$ref": "#/definitions/PerformanceMetricsListView" | ||
| "swagger":"2.0", | ||
| "info":{ | ||
| "title":"Performance API", | ||
| "version":"0.247.0", | ||
| "description":"Performance API provides essential information about performance of tested web application." | ||
| }, | ||
| "host":"api.us-west-1.saucelabs.com", | ||
| "basePath":"/v2/performance", | ||
| "schemes":[ | ||
| "https" | ||
| ], | ||
| "produces":[ | ||
| "application/json" | ||
| ], | ||
| "paths":{ | ||
| "/metrics/":{ | ||
| "get":{ | ||
| "operationId": "get_performance_metrics", | ||
| "description":"Provides a list of paginated raw performance metrics for the logged user", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/PageUrl" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/PerformanceUserMetricsView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/":{ | ||
| "get":{ | ||
| "operationId": "get_performance_metrics_by_jobID", | ||
| "description":"Provides performance metrics and job basic data for a given job_id", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/Full" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/PerformanceMetricsListView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/baseline/history/": { | ||
| "get": { | ||
| "operationId": "get_baseline_history", | ||
| "summary": "Get baseline history of specific test.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/OrderIndex" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/Limit" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/WindowSize" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Gets baseline history based on job_id and given parameters", | ||
| "schema": { | ||
| "$ref": "#/definitions/BaselineHistoryView" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/assert/":{ | ||
| "get":{ | ||
| "operationId": "assert_performance", | ||
| "description":"Provides information if there is an outlier for the given job_id and metric", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/AssertView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/baseline/":{ | ||
| "get":{ | ||
| "operationId": "get_baseline", | ||
| "description":"Provides baseline based on metrics history, where the reference point is a given job_id", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/RegimeStart" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/RegimeEnd" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/BaselineView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/baseline/command/": { | ||
| "get": { | ||
| "operationId": "get_recent_baseline_history", | ||
| "summary": "Gets recent baseline based on job_id and given parameters", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/OrderIndex" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/WindowSize" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Gets recent baseline based on job_id and given parameters", | ||
| "schema": { | ||
| "$ref": "#/definitions/BaselineCommandView" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/baseline/reset/":{ | ||
| "get":{ | ||
| "operationId": "has_baseline_reset", | ||
| "description":"Returns true if a baseline was resetted for a give job_id", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| }, | ||
| "post":{ | ||
| "operationId": "acknowledge_baseline", | ||
| "description":"Sets a reset point market at job_id, previous jobs will not be taken into account in calculating baseline", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "201":{ | ||
| "description":"Sets a reset point market at job_id, previous jobs will not be taken into account in calculating baseline" | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/regime_acknowledge/": { | ||
| "patch": { | ||
| "operationId": "acknowledge_regime", | ||
| "summary": "Acknowledge Regime.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/RegimeAcknowledgeBody" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Regime acknowledged.", | ||
| "schema": { | ||
| "$ref": "#/definitions/PerformanceMetricsListViewItems" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/discarded/":{ | ||
| "get":{ | ||
| "operationId": "get_discarded_outliers", | ||
| "description":"Provides lists outliers marked as discarded", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/DiscardedView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| }, | ||
| "post":{ | ||
| "operationId": "discard_outliers", | ||
| "description":"Marks outlier for a given {job_id} as not relevant/flaky", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "201":{ | ||
| "description":"Marks outlier for a given {job_id} as not relevant/flaky" | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/regressions/": { | ||
| "get": { | ||
| "operationId": "assert_performance_regression", | ||
| "summary": "Shows if there's a regression detected for given job_id and metric_names", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/WindowSize" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Shows if there's a regression detected for given job_id and metric_names", | ||
| "schema": { | ||
| "$ref": "#/definitions/PerformanceMetricsRegressionListView" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/history/":{ | ||
| "get":{ | ||
| "operationId": "get_baseline_history", | ||
| "description":"Provides a list of raw performance metrics up to point where the reference is a given job_id and order_index", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/Limit" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/PerformanceMetricsHistoryView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/regimes/":{ | ||
| "get":{ | ||
| "operationId": "get_regimes", | ||
| "description":"Provides regimes per metric calculated for a set of jobs, where the reference point is a given job_id", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/MetricNames" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/IncludeBaseline" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200":{ | ||
| "schema":{ | ||
| "$ref":"#/definitions/RegimesView" | ||
| } | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/dataset/": { | ||
| "get": { | ||
| "operationId": "get_performance_dataset", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/MetricNames" | ||
| } | ||
| ], | ||
| "summary": "Returns a dataset used to calculate regressions and baselines", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Returns a dataset used to calculate regressions and baselines", | ||
| "schema": { | ||
| "$ref": "#/definitions/PerformanceMetricsDataSetListView" | ||
| } | ||
| }, | ||
| "/metrics/{job_id}/regimes/acknowledge/":{ | ||
| "post":{ | ||
| "operationId": "acknowledge_regime", | ||
| "description":"Acknowledge regime. Confirm values in new regime are acceptable.", | ||
| "parameters":[ | ||
| { | ||
| "$ref":"#/parameters/JobId" | ||
| }, | ||
| { | ||
| "$ref":"#/parameters/OrderIndex" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "201":{ | ||
| "description":"Acknowledge regime. Confirm values in new regime are acceptable." | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| }, | ||
| "/metrics/swagger/":{ | ||
| "get":{ | ||
| "operationId": "get_api_definition", | ||
| "description":"Provides json documentation for the performance API", | ||
| "responses":{ | ||
| "200":{ | ||
| "description":"Provides json documentation for the performance API" | ||
| }, | ||
| "default":{ | ||
| "description":"Error response", | ||
| "schema":{ | ||
| "$ref":"#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "JobId": { | ||
| "name": "job_id", | ||
| "in": "path", | ||
| "type": "string", | ||
| "required": true | ||
| }, | ||
| "JobOwner": { | ||
| "name": "job_owner", | ||
| "in": "query", | ||
| "type": "string", | ||
| "required": false | ||
| }, | ||
| "MetricNames": { | ||
| "name": "metric_names", | ||
| "in": "query", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "parameters":{ | ||
| "JobId":{ | ||
| "name":"job_id", | ||
| "in":"path", | ||
| "type":"string", | ||
| "required":true | ||
| }, | ||
| "required": true | ||
| }, | ||
| "MetricName": { | ||
| "name": "metric_names", | ||
| "in": "query", | ||
| "type": "string", | ||
| "required": true | ||
| }, | ||
| "JobNameHash": { | ||
| "name": "job_name_hash", | ||
| "in": "query", | ||
| "type": "string", | ||
| "required": true | ||
| }, | ||
| "OrderIndex": { | ||
| "name": "order_index", | ||
| "in": "query", | ||
| "type": "integer", | ||
| "required": true | ||
| }, | ||
| "EndTime": { | ||
| "name": "end_time", | ||
| "in": "query", | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "required": false | ||
| }, | ||
| "Limit": { | ||
| "name": "limit", | ||
| "in": "query", | ||
| "type": "integer", | ||
| "required": false | ||
| }, | ||
| "WindowSize": { | ||
| "name": "window_size", | ||
| "in": "query", | ||
| "type": "integer", | ||
| "required": false | ||
| }, | ||
| "RegimeAcknowledgeBody": { | ||
| "name": "body", | ||
| "in": "body", | ||
| "description": "Data needed to acknowledge the regime", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/RegimeAcknowledgeList" | ||
| "Full":{ | ||
| "name":"full", | ||
| "in":"query", | ||
| "type":"boolean", | ||
| "required":false, | ||
| "default":true, | ||
| "description":"When set to false, basic job data will be returned, excluding performance metrics" | ||
| }, | ||
| "MetricNames":{ | ||
| "name":"metric_names", | ||
| "in":"query", | ||
| "type":"array", | ||
| "items":{ | ||
| "type":"string" | ||
| }, | ||
| "required":true | ||
| }, | ||
| "OrderIndex":{ | ||
| "name":"order_index", | ||
| "in":"query", | ||
| "type":"integer", | ||
| "required":true | ||
| }, | ||
| "PageUrl":{ | ||
| "name":"page_url", | ||
| "in":"query", | ||
| "type":"string", | ||
| "required":false | ||
| }, | ||
| "Limit":{ | ||
| "name":"limit", | ||
| "in":"query", | ||
| "type":"integer", | ||
| "required":false | ||
| }, | ||
| "RegimeStart":{ | ||
| "name":"regime_start", | ||
| "in":"query", | ||
| "type":"integer", | ||
| "required":false | ||
| }, | ||
| "RegimeEnd":{ | ||
| "name":"regime_end", | ||
| "in":"query", | ||
| "type":"integer", | ||
| "required":false | ||
| }, | ||
| "IncludeBaseline":{ | ||
| "name":"include_baseline", | ||
| "in":"query", | ||
| "type":"boolean", | ||
| "default":false, | ||
| "required":false | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "PerformanceMetricsListView": { | ||
| "type": "object", | ||
| "properties": { | ||
| "items": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/PerformanceMetricsListViewItems" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "PerformanceMetricsListViewItems": { | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "type": "integer" | ||
| }, | ||
| "job_id": { | ||
| "type": "string" | ||
| }, | ||
| "job_owner": { | ||
| "type": "string" | ||
| }, | ||
| "page_url": { | ||
| "type": "string" | ||
| }, | ||
| "order_index": { | ||
| "type": "integer" | ||
| }, | ||
| "job_creation_time": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "metric_data": { | ||
| "$ref": "#/definitions/PerformanceMetricsDetails" | ||
| }, | ||
| "regime_acknowledge": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "PerformanceMetricsDetails": { | ||
| "type": "object", | ||
| "properties": { | ||
| "load": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "font_size": { | ||
| "type": "integer" | ||
| }, | ||
| "firstPaint": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "font_count": { | ||
| "type": "integer" | ||
| }, | ||
| "image_size": { | ||
| "type": "integer" | ||
| }, | ||
| "other_size": { | ||
| "type": "integer" | ||
| }, | ||
| "pageWeight": { | ||
| "type": "integer" | ||
| }, | ||
| "speedIndex": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "image_count": { | ||
| "type": "integer" | ||
| }, | ||
| "other_count": { | ||
| "type": "integer" | ||
| }, | ||
| "script_size": { | ||
| "type": "integer" | ||
| }, | ||
| "requestsSize": { | ||
| "type": "integer" | ||
| }, | ||
| "script_count": { | ||
| "type": "integer" | ||
| }, | ||
| "document_size": { | ||
| "type": "integer" | ||
| }, | ||
| "requestsCount": { | ||
| "type": "integer" | ||
| }, | ||
| "document_count": { | ||
| "type": "integer" | ||
| }, | ||
| "timeToFirstByte": { | ||
| "type": "integer" | ||
| }, | ||
| "domContentLoaded": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "pageWeightEncoded": { | ||
| "type": "integer" | ||
| }, | ||
| "firstContentfulPaint": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "firstMeaningfulPaint": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "perceptualSpeedIndex": { | ||
| "type": "number", | ||
| "format": "float" | ||
| }, | ||
| "timeToFirstInteractive": { | ||
| "type": "number", | ||
| "format": "float" | ||
| } | ||
| } | ||
| }, | ||
| "BaselineHistoryView": { | ||
| "type": "object", | ||
| "properties": { | ||
| "load": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| } | ||
| }, | ||
| "requestsCount": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| } | ||
| }, | ||
| "pageWeight": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| } | ||
| }, | ||
| "speedIndex": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "BaselineCommandView": { | ||
| "type": "object", | ||
| "properties": { | ||
| "load": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| }, | ||
| "requestsCount": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| }, | ||
| "pageWeight": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| }, | ||
| "speedIndex": { | ||
| "$ref": "#/definitions/BaselineDetails" | ||
| } | ||
| } | ||
| }, | ||
| "BaselineDetails": { | ||
| "type": "object", | ||
| "properties": { | ||
| "b": { | ||
| "type": "number", | ||
| "format": "float", | ||
| "description": "Baseline" | ||
| }, | ||
| "u": { | ||
| "type": "number", | ||
| "format": "float", | ||
| "description": "Upper boundry" | ||
| }, | ||
| "l": { | ||
| "type": "number", | ||
| "format": "float", | ||
| "description": "Lower boundry" | ||
| }, | ||
| "r": { | ||
| "type": "number", | ||
| "format": "float", | ||
| "description": "Real value" | ||
| }, | ||
| "job_id": { | ||
| "type": "string" | ||
| }, | ||
| "datetime": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "new_regime": { | ||
| "type": "number", | ||
| "format": "integer", | ||
| "enum": [ | ||
| 0, | ||
| 1 | ||
| ], | ||
| "description": "positive means a datapoint belongs to the new regime" | ||
| }, | ||
| "accepted": { | ||
| "type": "number", | ||
| "format": "integer", | ||
| "enum": [ | ||
| 0, | ||
| 1 | ||
| ], | ||
| "description": "positive means a datapoint regime is accepted" | ||
| } | ||
| } | ||
| }, | ||
| "RegimeAcknowledge": { | ||
| "type": "object", | ||
| "properties": { | ||
| "page_url": { | ||
| "type": "string" | ||
| }, | ||
| "order_index": { | ||
| "type": "integer" | ||
| }, | ||
| "metric_names": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "load", | ||
| "font_size", | ||
| "firstPaint", | ||
| "font_count", | ||
| "image_size", | ||
| "other_size", | ||
| "pageWeight", | ||
| "speedIndex", | ||
| "image_count", | ||
| "other_count", | ||
| "script_size", | ||
| "requestsSize", | ||
| "script_count", | ||
| "document_size", | ||
| "requestsCount", | ||
| "document_count", | ||
| "timeToFirstByte", | ||
| "domContentLoaded", | ||
| "pageWeightEncoded", | ||
| "firstContentfulPaint", | ||
| "firstMeaningfulPaint", | ||
| "perceptualSpeedIndex", | ||
| "timeToFirstInteractive" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "definitions":{ | ||
| "PerformanceMetricsListView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "items":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "$ref":"#/definitions/PerformanceMetricsListViewItems" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "page_url", | ||
| "order_index", | ||
| "metric_names" | ||
| ] | ||
| }, | ||
| "RegimeAcknowledgeList": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/RegimeAcknowledge" | ||
| "PerformanceMetricsListViewItems":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "job_id":{ | ||
| "type":"string" | ||
| }, | ||
| "job_owner":{ | ||
| "type":"string" | ||
| }, | ||
| "job_name_hash":{ | ||
| "type":"string" | ||
| }, | ||
| "page_url":{ | ||
| "type":"string" | ||
| }, | ||
| "order_index":{ | ||
| "type":"integer" | ||
| }, | ||
| "job_creation_time":{ | ||
| "type":"string", | ||
| "format":"date-time" | ||
| }, | ||
| "load_id":{ | ||
| "type":"string" | ||
| }, | ||
| "loader_id":{ | ||
| "type":"string" | ||
| }, | ||
| "error":{ | ||
| "type":"string" | ||
| }, | ||
| "metric_data":{ | ||
| "$ref":"#/definitions/PerformanceMetricsDetails" | ||
| } | ||
| } | ||
| }, | ||
| "minItems": 1 | ||
| }, | ||
| "PerformanceMetricsRegressionListView": { | ||
| "type": "object", | ||
| "properties": { | ||
| "items": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "page_url": { | ||
| "type": "string" | ||
| }, | ||
| "order_index": { | ||
| "type": "integer" | ||
| }, | ||
| "is_regression_detected": { | ||
| "type": "boolean" | ||
| }, | ||
| "metrics": { | ||
| "$ref": "#/definitions/PerformanceMetricsDetails" | ||
| } | ||
| "PerformanceMetricsHistoryView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "items":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "$ref":"#/definitions/PerformanceMetricsListViewItems" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "PerformanceMetricsDataSetListView": { | ||
| "type": "object", | ||
| "properties": { | ||
| "load": { | ||
| "type": "object", | ||
| "properties": { | ||
| "https://www.saucedemo.com/": { | ||
| "type": "object", | ||
| "properties": { | ||
| "0": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/BaselineItemInput" | ||
| } | ||
| }, | ||
| "PerformanceUserMetricsView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "items":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "$ref":"#/definitions/PerformanceMetricsListViewItems" | ||
| } | ||
| }, | ||
| "next":{ | ||
| "type":"string" | ||
| }, | ||
| "previous":{ | ||
| "type":"string" | ||
| } | ||
| } | ||
| }, | ||
| "PerformanceMetricsDetails":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "rtt":{ | ||
| "type":"number", | ||
| "format":"float" | ||
| }, | ||
| "load":{ | ||
| "type":"number", | ||
| "format":"float" | ||
| }, | ||
| "score":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "maxRtt":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numFonts":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasks":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "font_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstPaint":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "font_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "image_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numScripts":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "other_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "speedIndex":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "throughput":{ | ||
| "type":"number", | ||
| "format":"float" | ||
| }, | ||
| "image_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numRequests":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "other_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "script_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstCPUIdle":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "requestsSize":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "script_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "document_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "requestsCount":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "totalTaskTime":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "document_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numStylesheets":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "stylesheet_size":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "timeToFirstByte":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "totalByteWeight":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "domContentLoaded":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstInteractive":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "lastVisualChange":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "maxServerLatency":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasksOver10ms":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasksOver25ms":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasksOver50ms":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "stylesheet_count":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstVisualChange":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasksOver100ms":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "numTasksOver500ms":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstContentfulPaint":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "firstMeaningfulPaint":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "estimatedInputLatency":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| }, | ||
| "mainDocumentTransferSize":{ | ||
| "type":"number", | ||
| "format":"integer" | ||
| } | ||
| } | ||
| }, | ||
| "BaselineView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "metric_name":{ | ||
| "description":"metric name is one of the metrics provided in /metrics/{job_id}/", | ||
| "$ref":"#/definitions/BaselineDetails" | ||
| } | ||
| } | ||
| }, | ||
| "BaselineDetails":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "baseline":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Baseline" | ||
| }, | ||
| "upper_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Upper boundry" | ||
| }, | ||
| "lower_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Lower boundry" | ||
| }, | ||
| "values":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "$ref":"#/definitions/BaselineValues" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "BaselineValues":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "real_value":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Real value" | ||
| }, | ||
| "job_id":{ | ||
| "type":"string" | ||
| }, | ||
| "datetime":{ | ||
| "type":"string", | ||
| "format":"date-time" | ||
| } | ||
| } | ||
| }, | ||
| "OutlierDetails":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "status":{ | ||
| "type":"boolean" | ||
| }, | ||
| "reason":{ | ||
| "type":"string", | ||
| "enum":[ | ||
| "baseline", | ||
| "new_regime" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "AssertView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "metric_name":{ | ||
| "$ref":"#/definitions/AssertDetails" | ||
| } | ||
| } | ||
| }, | ||
| "AssertDetails":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "baseline":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Baseline" | ||
| }, | ||
| "upper_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Upper boundry" | ||
| }, | ||
| "lower_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Lower boundry" | ||
| }, | ||
| "real_value":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Real value" | ||
| }, | ||
| "job_id":{ | ||
| "type":"string" | ||
| }, | ||
| "datetime":{ | ||
| "type":"string", | ||
| "format":"date-time" | ||
| }, | ||
| "order_index":{ | ||
| "type":"integer" | ||
| }, | ||
| "outlier":{ | ||
| "$ref":"#/definitions/OutlierDetails" | ||
| } | ||
| } | ||
| }, | ||
| "RegimesView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "metric_name":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "type":"object", | ||
| "required":[ | ||
| "regime_start", | ||
| "regime_end", | ||
| "baseline_url", | ||
| "active" | ||
| ], | ||
| "properties":{ | ||
| "regime_start":{ | ||
| "type":"integer", | ||
| "description":"Left regime boundry" | ||
| }, | ||
| "regime_end":{ | ||
| "type":"integer", | ||
| "description":"Right regime boundry" | ||
| }, | ||
| "baseline_url":{ | ||
| "type":"string", | ||
| "description":"Path to baseline endpoint for given regime" | ||
| }, | ||
| "active":{ | ||
| "type":"boolean", | ||
| "description":"Informs if given regime is active - in force" | ||
| }, | ||
| "baseline":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "upper_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Upper boundry" | ||
| }, | ||
| "lower_boundary":{ | ||
| "type":"number", | ||
| "format":"float", | ||
| "description":"Lower boundry" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "DiscardedView":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "job_ids":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "type":"string" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "ErrorResponse":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "status":{ | ||
| "type":"string" | ||
| }, | ||
| "message":{ | ||
| "type":"string" | ||
| } | ||
| } | ||
| }, | ||
| "RegimeAcknowledge":{ | ||
| "type":"object", | ||
| "properties":{ | ||
| "page_url":{ | ||
| "type":"string" | ||
| }, | ||
| "order_index":{ | ||
| "type":"integer" | ||
| }, | ||
| "metric_names":{ | ||
| "type":"array", | ||
| "items":{ | ||
| "type":"string" | ||
| } | ||
| } | ||
| }, | ||
| "required":[ | ||
| "page_url", | ||
| "order_index", | ||
| "metric_names" | ||
| ] | ||
| } | ||
| }, | ||
| "BaselineItemInput": { | ||
| "type": "object", | ||
| "properties": { | ||
| "job_id": { | ||
| "type": "string" | ||
| }, | ||
| "datetime": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "value": { | ||
| "type": "number", | ||
| "format": "float" | ||
| } | ||
| } | ||
| }, | ||
| "ErrorResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "details": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
@@ -2324,18 +2324,2 @@ { | ||
| }, | ||
| "responses": { | ||
| "400": { | ||
| "description": "Bad request - typically some request parameter error", | ||
| "schema": { | ||
| "properties": { | ||
| "message": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "message" | ||
| ], | ||
| "type": "object" | ||
| } | ||
| } | ||
| }, | ||
| "schemes": [ | ||
@@ -2342,0 +2326,0 @@ "https" |
@@ -11,17 +11,42 @@ export interface SauceLabsOptions { | ||
| items?: Array<PerformanceMetricsListViewItems>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceMetricsListViewItems = { | ||
| id?: number; | ||
| job_id?: string; | ||
| job_owner?: string; | ||
| job_name_hash?: string; | ||
| page_url?: string; | ||
| order_index?: number; | ||
| job_creation_time?: string; | ||
| load_id?: string; | ||
| loader_id?: string; | ||
| error?: string; | ||
| metric_data?: PerformanceMetricsDetails; | ||
| regime_acknowledge?: Array<string>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceMetricsHistoryView = { | ||
| items?: Array<PerformanceMetricsListViewItems>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceUserMetricsView = { | ||
| items?: Array<PerformanceMetricsListViewItems>; | ||
| next?: string; | ||
| previous?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceMetricsDetails = { | ||
| rtt?: number; | ||
| load?: number; | ||
| score?: number; | ||
| maxRtt?: number; | ||
| numFonts?: number; | ||
| numTasks?: number; | ||
| font_size?: number; | ||
@@ -31,8 +56,11 @@ firstPaint?: number; | ||
| image_size?: number; | ||
| numScripts?: number; | ||
| other_size?: number; | ||
| pageWeight?: number; | ||
| speedIndex?: number; | ||
| throughput?: number; | ||
| image_count?: number; | ||
| numRequests?: number; | ||
| other_count?: number; | ||
| script_size?: number; | ||
| firstCPUIdle?: number; | ||
| requestsSize?: number; | ||
@@ -42,96 +70,118 @@ script_count?: number; | ||
| requestsCount?: number; | ||
| totalTaskTime?: number; | ||
| document_count?: number; | ||
| numStylesheets?: number; | ||
| stylesheet_size?: number; | ||
| timeToFirstByte?: number; | ||
| totalByteWeight?: number; | ||
| domContentLoaded?: number; | ||
| pageWeightEncoded?: number; | ||
| firstInteractive?: number; | ||
| lastVisualChange?: number; | ||
| maxServerLatency?: number; | ||
| numTasksOver10ms?: number; | ||
| numTasksOver25ms?: number; | ||
| numTasksOver50ms?: number; | ||
| stylesheet_count?: number; | ||
| firstVisualChange?: number; | ||
| numTasksOver100ms?: number; | ||
| numTasksOver500ms?: number; | ||
| firstContentfulPaint?: number; | ||
| firstMeaningfulPaint?: number; | ||
| perceptualSpeedIndex?: number; | ||
| timeToFirstInteractive?: number; | ||
| estimatedInputLatency?: number; | ||
| mainDocumentTransferSize?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type BaselineHistoryView = { | ||
| load?: Array<BaselineDetails>; | ||
| requestsCount?: Array<BaselineDetails>; | ||
| pageWeight?: Array<BaselineDetails>; | ||
| speedIndex?: Array<BaselineDetails>; | ||
| export type BaselineView = { | ||
| metric_name?: BaselineDetails; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type BaselineCommandView = { | ||
| load?: BaselineDetails; | ||
| requestsCount?: BaselineDetails; | ||
| pageWeight?: BaselineDetails; | ||
| speedIndex?: BaselineDetails; | ||
| export type BaselineDetails = { | ||
| baseline?: number; | ||
| upper_boundary?: number; | ||
| lower_boundary?: number; | ||
| values?: Array<BaselineValues>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type BaselineDetails = { | ||
| b?: number; | ||
| u?: number; | ||
| l?: number; | ||
| r?: number; | ||
| export type BaselineValues = { | ||
| real_value?: number; | ||
| job_id?: string; | ||
| datetime?: string; | ||
| new_regime?: 0 | 1; | ||
| accepted?: 0 | 1; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type RegimeAcknowledge = { | ||
| page_url: string; | ||
| order_index: number; | ||
| metric_names: Array< | ||
| | "load" | ||
| | "font_size" | ||
| | "firstPaint" | ||
| | "font_count" | ||
| | "image_size" | ||
| | "other_size" | ||
| | "pageWeight" | ||
| | "speedIndex" | ||
| | "image_count" | ||
| | "other_count" | ||
| | "script_size" | ||
| | "requestsSize" | ||
| | "script_count" | ||
| | "document_size" | ||
| | "requestsCount" | ||
| | "document_count" | ||
| | "timeToFirstByte" | ||
| | "domContentLoaded" | ||
| | "pageWeightEncoded" | ||
| | "firstContentfulPaint" | ||
| | "firstMeaningfulPaint" | ||
| | "perceptualSpeedIndex" | ||
| | "timeToFirstInteractive" | ||
| >; | ||
| export type OutlierDetails = { | ||
| status?: boolean; | ||
| reason?: "baseline" | "new_regime"; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type RegimeAcknowledgeList = Array<RegimeAcknowledge>; | ||
| export type AssertView = { | ||
| metric_name?: AssertDetails; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceMetricsRegressionListView = { | ||
| items?: Array<{ | ||
| page_url?: string; | ||
| order_index?: number; | ||
| is_regression_detected?: boolean; | ||
| metrics?: PerformanceMetricsDetails; | ||
| }>; | ||
| export type AssertDetails = { | ||
| baseline?: number; | ||
| upper_boundary?: number; | ||
| lower_boundary?: number; | ||
| real_value?: number; | ||
| job_id?: string; | ||
| datetime?: string; | ||
| order_index?: number; | ||
| outlier?: OutlierDetails; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PerformanceMetricsDataSetListView = { | ||
| load?: { | ||
| "https://www.saucedemo.com/"?: { | ||
| "0"?: Array<BaselineItemInput>; | ||
| }; | ||
| }; | ||
| export type RegimesView = { | ||
| metric_name?: Array< | ||
| { | ||
| regime_start: number; | ||
| regime_end: number; | ||
| baseline_url: string; | ||
| active: boolean; | ||
| baseline?: { | ||
| upper_boundary?: number; | ||
| lower_boundary?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| } & { | ||
| [key: string]: any; | ||
| } | ||
| >; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type BaselineItemInput = { | ||
| job_id?: string; | ||
| datetime?: string; | ||
| value?: number; | ||
| export type DiscardedView = { | ||
| job_ids?: Array<string>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type ErrorResponse = { | ||
| details?: string; | ||
| status?: string; | ||
| message?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type RegimeAcknowledge = { | ||
| page_url: string; | ||
| order_index: number; | ||
| metric_names: Array<string>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PaginationSettings = { | ||
@@ -142,2 +192,4 @@ offset?: number; | ||
| sortDirection?: "ASCENDING" | "DESCENDING"; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -150,5 +202,7 @@ | ||
| frameworkVersion?: string; | ||
| deviceIds?: { | ||
| deviceIds?: {} & { | ||
| [key: string]: Array<Id>; | ||
| }; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -159,2 +213,4 @@ | ||
| url?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -168,2 +224,4 @@ | ||
| deviceIds?: Array<Id>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -225,5 +283,9 @@ | ||
| deviceId?: Id; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type StreamingOutput = {}; | ||
| export type StreamingOutput = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -233,2 +295,4 @@ export type ApiTestReport = { | ||
| test?: ApiTest; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -239,2 +303,4 @@ | ||
| metaData?: PaginationSettings; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -301,2 +367,4 @@ | ||
| vitalsLog?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -340,2 +408,4 @@ | ||
| totalDuration?: Duration; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -353,2 +423,4 @@ | ||
| | "CANCELED"; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -366,2 +438,4 @@ | ||
| | "UNPLUGGED"; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -372,2 +446,4 @@ | ||
| testReports?: Array<ApiTestReport>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -380,2 +456,4 @@ | ||
| dataCenterId?: Id; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -386,2 +464,4 @@ | ||
| nano?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -393,2 +473,4 @@ | ||
| deviceId?: Id; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -402,2 +484,4 @@ | ||
| nano?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -408,2 +492,4 @@ | ||
| testCases?: Array<TestCase>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -464,2 +550,4 @@ | ||
| methodName?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -469,2 +557,4 @@ | ||
| passed?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -475,5 +565,9 @@ | ||
| view?: TestReportView; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Id = {}; | ||
| export type Id = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -524,2 +618,4 @@ export type TestReport = { | ||
| type?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -529,3 +625,3 @@ | ||
| frameworkVersion?: string; | ||
| deviceIds?: { | ||
| deviceIds?: {} & { | ||
| [key: string]: Array<Id>; | ||
@@ -536,2 +632,4 @@ }; | ||
| id?: Id; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -557,2 +655,4 @@ | ||
| | "CANCELED"; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -609,2 +709,4 @@ | ||
| name?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -615,5 +717,7 @@ | ||
| reason?: string; | ||
| info?: { | ||
| info?: {} & { | ||
| [key: string]: string; | ||
| }; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -643,2 +747,4 @@ | ||
| durationInSeconds?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -649,2 +755,4 @@ | ||
| deviceDescriptor?: DeviceDescriptor; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -656,2 +764,4 @@ | ||
| error?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -712,5 +822,9 @@ | ||
| second?: Id; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type SharedLiveViewId = {}; | ||
| export type SharedLiveViewId = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -722,5 +836,9 @@ export type TemporalUnit = { | ||
| timeBased?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type InputStream = {}; | ||
| export type InputStream = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -767,2 +885,4 @@ export type DeviceDescriptor = { | ||
| supportsQualityReport?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -773,2 +893,4 @@ | ||
| y?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -808,5 +930,7 @@ | ||
| reason?: string; | ||
| info?: { | ||
| info?: {} & { | ||
| [key: string]: string; | ||
| }; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -839,3 +963,5 @@ | ||
| export type Uuid = {}; | ||
| export type Uuid = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -856,2 +982,4 @@ export type TestCase = { | ||
| testError?: TestError; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -882,2 +1010,4 @@ | ||
| secretLinkCode?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -889,5 +1019,9 @@ | ||
| className?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type PhoneNumber = {}; | ||
| export type PhoneNumber = {} & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -998,2 +1132,24 @@ export type XCUITestReport = { | ||
| export type Response_uploadApp_200 = string; | ||
| export type Response_readDeviceIds_200 = Array<Id>; | ||
| export type Response_getDescriptors_200 = {} & { | ||
| [key: string]: Array<DeviceDescriptor>; | ||
| }; | ||
| export type Response_getDescriptorsApi_200 = Array<DeviceDescriptor>; | ||
| export type Response_getAvailableDescriptorIdsApi_200 = Array<Id>; | ||
| export type Response_getAvailableDescriptorIds_200 = {} & { | ||
| [key: string]: Array<Id>; | ||
| }; | ||
| export type Response_getDeviceStatusInfos_200 = Array<DeviceStatusInfo>; | ||
| export type Response_getDescriptor_200 = {} & { | ||
| [key: string]: DeviceDescriptor; | ||
| }; | ||
| export type Activity = { | ||
@@ -1004,2 +1160,4 @@ ccy_exec_peak: Array<number>; | ||
| minutes: Array<number>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1013,2 +1171,4 @@ | ||
| version?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1030,2 +1190,4 @@ | ||
| running?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1042,2 +1204,4 @@ modification_time?: number; | ||
| status?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1048,2 +1212,4 @@ | ||
| platform_version?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1054,9 +1220,13 @@ | ||
| error?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Concurrency = { | ||
| concurrency: { | ||
| concurrency: {} & { | ||
| [key: string]: SubAccountConcurrencyValues; | ||
| }; | ||
| timestamp: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1069,2 +1239,4 @@ | ||
| scout?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1076,2 +1248,4 @@ | ||
| overall?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1083,2 +1257,4 @@ | ||
| message?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1091,2 +1267,4 @@ | ||
| size: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1130,2 +1308,4 @@ | ||
| video_url?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1145,2 +1325,4 @@ | ||
| supported_backend_versions?: Array<string>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1152,2 +1334,4 @@ | ||
| wait_time?: number; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1158,2 +1342,4 @@ | ||
| remaining?: ConcurrencyValues; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1182,2 +1368,4 @@ | ||
| vm_version?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1193,2 +1381,4 @@ | ||
| release?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1222,2 +1412,4 @@ | ||
| vm_lockdown?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
@@ -1242,4 +1434,144 @@ | ||
| verified?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_user_organization_200 = { | ||
| count?: number; | ||
| is_ancestor?: boolean; | ||
| users?: Array<string>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_available_tunnels_200 = {} & { | ||
| [key: string]: Array<Tunnel>; | ||
| }; | ||
| export type Response_list_builds_200 = Array<Build>; | ||
| export type Response_list_jobs_200 = { | ||
| jobs?: Array<Job>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_get_dashboard_message_for_user_200 = { | ||
| response?: { | ||
| cta?: string; | ||
| id?: string; | ||
| message?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| status?: boolean; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_platforms_200 = Array<Platform>; | ||
| export type Response_delete_manual_job_200 = {}; | ||
| export type Response_create_manual_job_200 = { | ||
| error?: boolean; | ||
| job_id?: void; | ||
| metadata: { | ||
| browser: string; | ||
| os: string; | ||
| resolution: string; | ||
| tunnel?: void; | ||
| url: string; | ||
| version: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| task_id: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_manual_platforms_200 = {} & { | ||
| [key: string]: {} & { | ||
| [key: string]: { | ||
| browser?: string; | ||
| platform?: string; | ||
| resolutions?: Array<string>; | ||
| version?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| }; | ||
| }; | ||
| export type Response_get_manual_job_200 = { | ||
| browser: string; | ||
| members: Array<string>; | ||
| os: string; | ||
| owner: string; | ||
| resolution: string; | ||
| tunnel?: void; | ||
| url: string; | ||
| version: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_create_manual_job_screenshot_201 = {}; | ||
| export type Response_get_current_user_200 = { | ||
| exp?: number; | ||
| iat?: number; | ||
| username?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_delete_manual_job_legacy_200 = {}; | ||
| export type Response_create_manual_job_legacy_200 = { | ||
| error?: boolean; | ||
| job_id?: void; | ||
| metadata: { | ||
| browser: string; | ||
| os: string; | ||
| resolution: string; | ||
| tunnel?: void; | ||
| url: string; | ||
| version: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| task_id: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_get_user_minutes_200 = { | ||
| automated?: string; | ||
| manual?: string; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_get_users_activity_200 = {} & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_users_last_job_200 = {} & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_all_tunnels_200 = { | ||
| tunnels?: Array<Tunnel>; | ||
| } & { | ||
| [key: string]: any; | ||
| }; | ||
| export type Response_list_build_failed_jobs_200 = Array<Job>; | ||
| export type Response_list_build_jobs_200 = Array<Job>; | ||
| export type Response_list_tunnels_200 = Array<string>; | ||
| declare class SauceLabs { | ||
@@ -1249,39 +1581,52 @@ constructor(options: SauceLabsOptions); | ||
| /** | ||
| * Get performance metrics of specific test. | ||
| * Provides a list of paginated raw performance metrics for the logged user | ||
| * @method | ||
| * @name SauceLabs#getPerformanceMetrics | ||
| * @param {string} jobId - | ||
| * @param {string} pageUrl - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| getPerformanceMetrics(jobId: string): Promise<PerformanceMetricsListView>; | ||
| getPerformanceMetrics(options?: { | ||
| pageUrl?: string; | ||
| }): Promise<PerformanceUserMetricsView>; | ||
| /** | ||
| * Get baseline history of specific test. | ||
| * Provides performance metrics and job basic data for a given job_id | ||
| * @method | ||
| * @name SauceLabs#getBaselineHistory | ||
| * @param {string} jobId - | ||
| * @param {array} metricNames - Option | ||
| * @param {integer} orderIndex - Option | ||
| * @param {integer} limit - Option | ||
| * @param {integer} windowSize - Option | ||
| * @name SauceLabs#getPerformanceMetricsByJobId | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {boolean} full - When set to false, basic job data will be returned, excluding performance metricsOption | ||
| */ | ||
| getBaselineHistory( | ||
| getPerformanceMetricsByJobId( | ||
| jobId: string, | ||
| options?: { | ||
| full?: boolean; | ||
| } | ||
| ): Promise<PerformanceMetricsListView>; | ||
| /** | ||
| * Provides information if there is an outlier for the given job_id and metric | ||
| * @method | ||
| * @name SauceLabs#assertPerformance | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {array} metricNames - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| assertPerformance( | ||
| jobId: string, | ||
| options?: { | ||
| metricNames: Array<string>; | ||
| orderIndex: number; | ||
| limit?: number; | ||
| windowSize?: number; | ||
| } | ||
| ): Promise<BaselineHistoryView>; | ||
| ): Promise<AssertView>; | ||
| /** | ||
| * Gets recent baseline based on job_id and given parameters | ||
| * Provides baseline based on metrics history, where the reference point is a given job_id | ||
| * @method | ||
| * @name SauceLabs#getRecentBaselineHistory | ||
| * @param {string} jobId - | ||
| * @param {array} metricNames - Option | ||
| * @param {integer} orderIndex - Option | ||
| * @param {integer} windowSize - Option | ||
| * @name SauceLabs#getBaseline | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {array} metricNames - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} regimeStart - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} regimeEnd - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| getRecentBaselineHistory( | ||
| getBaseline( | ||
| jobId: string, | ||
@@ -1291,49 +1636,107 @@ options?: { | ||
| orderIndex: number; | ||
| windowSize?: number; | ||
| regimeStart?: number; | ||
| regimeEnd?: number; | ||
| } | ||
| ): Promise<BaselineCommandView>; | ||
| ): Promise<BaselineView>; | ||
| /** | ||
| * Acknowledge Regime. | ||
| * Returns true if a baseline was resetted for a give job_id | ||
| * @method | ||
| * @name SauceLabs#acknowledgeRegime | ||
| * @param {string} jobId - | ||
| * @param {} body - Data needed to acknowledge the regime | ||
| * @name SauceLabs#hasBaselineReset | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| */ | ||
| acknowledgeRegime( | ||
| hasBaselineReset(jobId: string): Promise<ErrorResponse>; | ||
| /** | ||
| * Sets a reset point market at job_id, previous jobs will not be taken into account in calculating baseline | ||
| * @method | ||
| * @name SauceLabs#acknowledgeBaseline | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| */ | ||
| acknowledgeBaseline(jobId: string): Promise<void>; | ||
| /** | ||
| * Provides lists outliers marked as discarded | ||
| * @method | ||
| * @name SauceLabs#getDiscardedOutliers | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| getDiscardedOutliers( | ||
| jobId: string, | ||
| body: RegimeAcknowledgeList | ||
| ): Promise<PerformanceMetricsListViewItems>; | ||
| options?: { | ||
| orderIndex: number; | ||
| } | ||
| ): Promise<DiscardedView>; | ||
| /** | ||
| * Shows if there's a regression detected for given job_id and metric_names | ||
| * Marks outlier for a given {job_id} as not relevant/flaky | ||
| * @method | ||
| * @name SauceLabs#assertPerformanceRegression | ||
| * @param {string} jobId - | ||
| * @param {array} metricNames - Option | ||
| * @param {integer} windowSize - Option | ||
| * @name SauceLabs#discardOutliers | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| assertPerformanceRegression( | ||
| discardOutliers( | ||
| jobId: string, | ||
| options?: { | ||
| metricNames: Array<string>; | ||
| windowSize?: number; | ||
| orderIndex: number; | ||
| } | ||
| ): Promise<PerformanceMetricsRegressionListView>; | ||
| ): Promise<void>; | ||
| /** | ||
| * Returns a dataset used to calculate regressions and baselines | ||
| * Provides a list of raw performance metrics up to point where the reference is a given job_id and order_index | ||
| * @method | ||
| * @name SauceLabs#getPerformanceDataset | ||
| * @param {string} jobId - | ||
| * @param {array} metricNames - Option | ||
| * @name SauceLabs#getBaselineHistory | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} limit - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| getPerformanceDataset( | ||
| getBaselineHistory( | ||
| jobId: string, | ||
| options?: { | ||
| orderIndex: number; | ||
| limit?: number; | ||
| } | ||
| ): Promise<PerformanceMetricsHistoryView>; | ||
| /** | ||
| * Provides regimes per metric calculated for a set of jobs, where the reference point is a given job_id | ||
| * @method | ||
| * @name SauceLabs#getRegimes | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {array} metricNames - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| * @param {boolean} includeBaseline - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| getRegimes( | ||
| jobId: string, | ||
| options?: { | ||
| metricNames: Array<string>; | ||
| orderIndex: number; | ||
| includeBaseline?: boolean; | ||
| } | ||
| ): Promise<PerformanceMetricsDataSetListView>; | ||
| ): Promise<RegimesView>; | ||
| /** | ||
| * Acknowledge regime. Confirm values in new regime are acceptable. | ||
| * @method | ||
| * @name SauceLabs#acknowledgeRegime | ||
| * @param {string} jobId - Performance API provides essential information about performance of tested web application. | ||
| * @param {integer} orderIndex - Performance API provides essential information about performance of tested web application.Option | ||
| */ | ||
| acknowledgeRegime( | ||
| jobId: string, | ||
| options?: { | ||
| orderIndex: number; | ||
| } | ||
| ): Promise<void>; | ||
| /** | ||
| * Provides json documentation for the performance API | ||
| * @method | ||
| * @name SauceLabs#getApiDefinition | ||
| */ | ||
| getApiDefinition(): Promise<void>; | ||
| /** | ||
| * Returns new application id after the upload. | ||
@@ -1354,3 +1757,3 @@ * @method | ||
| body?: InputStream | ||
| ): Promise<string>; | ||
| ): Promise<Response_uploadApp_200>; | ||
@@ -1406,3 +1809,3 @@ /** | ||
| */ | ||
| readDeviceIds(suiteId: number): Promise<Array<Id>>; | ||
| readDeviceIds(suiteId: number): Promise<Response_readDeviceIds_200>; | ||
@@ -1487,5 +1890,3 @@ /** | ||
| */ | ||
| getDescriptors(): Promise<{ | ||
| [key: string]: Array<DeviceDescriptor>; | ||
| }>; | ||
| getDescriptors(): Promise<Response_getDescriptors_200>; | ||
@@ -1497,5 +1898,3 @@ /** | ||
| */ | ||
| getAvailableDescriptorIds(): Promise<{ | ||
| [key: string]: Array<Id>; | ||
| }>; | ||
| getAvailableDescriptorIds(): Promise<Response_getAvailableDescriptorIds_200>; | ||
@@ -1508,7 +1907,3 @@ /** | ||
| */ | ||
| getDescriptor( | ||
| deviceId: string | ||
| ): Promise<{ | ||
| [key: string]: DeviceDescriptor; | ||
| }>; | ||
| getDescriptor(deviceId: string): Promise<Response_getDescriptor_200>; | ||
@@ -1595,3 +1990,5 @@ /** | ||
| */ | ||
| listUserOrganization(username: string): Promise<object>; | ||
| listUserOrganization( | ||
| username: string | ||
| ): Promise<Response_list_user_organization_200>; | ||
@@ -1606,5 +2003,3 @@ /** | ||
| username: string | ||
| ): Promise<{ | ||
| [key: string]: Array<Tunnel>; | ||
| }>; | ||
| ): Promise<Response_list_available_tunnels_200>; | ||
@@ -1625,3 +2020,3 @@ /** | ||
| } | ||
| ): Promise<Array<Build>>; | ||
| ): Promise<Response_list_builds_200>; | ||
@@ -1658,3 +2053,3 @@ /** | ||
| } | ||
| ): Promise<object>; | ||
| ): Promise<Response_list_jobs_200>; | ||
@@ -1667,3 +2062,5 @@ /** | ||
| */ | ||
| getDashboardMessageForUser(username: string): Promise<object>; | ||
| getDashboardMessageForUser( | ||
| username: string | ||
| ): Promise<Response_get_dashboard_message_for_user_200>; | ||
@@ -1678,3 +2075,3 @@ /** | ||
| platform: "appium" | "webdriver" | "all" | ||
| ): Promise<Array<Platform>>; | ||
| ): Promise<Response_list_platforms_200>; | ||
@@ -1694,3 +2091,3 @@ /** | ||
| */ | ||
| deleteManualJob(ids: Array<string>): Promise<object>; | ||
| deleteManualJob(ids: Array<string>): Promise<Response_delete_manual_job_200>; | ||
@@ -1703,15 +2100,19 @@ /** | ||
| */ | ||
| createManualJob(capabilities: { | ||
| assets: boolean; | ||
| browser: string; | ||
| browserDisplay: string; | ||
| browserVersionDisplay: string; | ||
| device?: string; | ||
| os: string; | ||
| osDisplay: string; | ||
| res: string; | ||
| tunnel?: string; | ||
| url: string; | ||
| version: string; | ||
| }): Promise<object>; | ||
| createManualJob( | ||
| capabilities: { | ||
| assets: boolean; | ||
| browser: string; | ||
| browserDisplay: string; | ||
| browserVersionDisplay: string; | ||
| device?: string; | ||
| os: string; | ||
| osDisplay: string; | ||
| res: string; | ||
| tunnel?: string; | ||
| url: string; | ||
| version: string; | ||
| } & { | ||
| [key: string]: any; | ||
| } | ||
| ): Promise<Response_create_manual_job_200>; | ||
@@ -1723,7 +2124,3 @@ /** | ||
| */ | ||
| listManualPlatforms(): Promise<{ | ||
| [key: string]: { | ||
| [key: string]: object; | ||
| }; | ||
| }>; | ||
| listManualPlatforms(): Promise<Response_list_manual_platforms_200>; | ||
@@ -1736,3 +2133,3 @@ /** | ||
| */ | ||
| getManualJob(taskId: string): Promise<object>; | ||
| getManualJob(taskId: string): Promise<Response_get_manual_job_200>; | ||
@@ -1745,3 +2142,5 @@ /** | ||
| */ | ||
| createManualJobScreenshot(taskId: string): Promise<object>; | ||
| createManualJobScreenshot( | ||
| taskId: string | ||
| ): Promise<Response_create_manual_job_screenshot_201>; | ||
@@ -1753,3 +2152,3 @@ /** | ||
| */ | ||
| getCurrentUser(): Promise<object>; | ||
| getCurrentUser(): Promise<Response_get_current_user_200>; | ||
@@ -1762,3 +2161,5 @@ /** | ||
| */ | ||
| deleteManualJobLegacy(ids: Array<string>): Promise<object>; | ||
| deleteManualJobLegacy( | ||
| ids: Array<string> | ||
| ): Promise<Response_delete_manual_job_legacy_200>; | ||
@@ -1771,15 +2172,19 @@ /** | ||
| */ | ||
| createManualJobLegacy(capabilities: { | ||
| assets: boolean; | ||
| browser: string; | ||
| browserDisplay: string; | ||
| browserVersionDisplay: string; | ||
| device?: string; | ||
| os: string; | ||
| osDisplay: string; | ||
| res: string; | ||
| tunnel?: string; | ||
| url: string; | ||
| version: string; | ||
| }): Promise<object>; | ||
| createManualJobLegacy( | ||
| capabilities: { | ||
| assets: boolean; | ||
| browser: string; | ||
| browserDisplay: string; | ||
| browserVersionDisplay: string; | ||
| device?: string; | ||
| os: string; | ||
| osDisplay: string; | ||
| res: string; | ||
| tunnel?: string; | ||
| url: string; | ||
| version: string; | ||
| } & { | ||
| [key: string]: any; | ||
| } | ||
| ): Promise<Response_create_manual_job_legacy_200>; | ||
@@ -1816,3 +2221,3 @@ /** | ||
| */ | ||
| getUserMinutes(username: string): Promise<object>; | ||
| getUserMinutes(username: string): Promise<Response_get_user_minutes_200>; | ||
@@ -1824,3 +2229,3 @@ /** | ||
| */ | ||
| getUsersActivity(): Promise<object>; | ||
| getUsersActivity(): Promise<Response_get_users_activity_200>; | ||
@@ -1832,3 +2237,3 @@ /** | ||
| */ | ||
| usersLastJob(): Promise<object>; | ||
| usersLastJob(): Promise<Response_users_last_job_200>; | ||
@@ -1848,3 +2253,3 @@ /** | ||
| */ | ||
| listAllTunnels(username: string): Promise<object>; | ||
| listAllTunnels(username: string): Promise<Response_list_all_tunnels_200>; | ||
@@ -1858,3 +2263,6 @@ /** | ||
| */ | ||
| listBuildFailedJobs(username: string, id: string): Promise<Array<Job>>; | ||
| listBuildFailedJobs( | ||
| username: string, | ||
| id: string | ||
| ): Promise<Response_list_build_failed_jobs_200>; | ||
@@ -1873,3 +2281,3 @@ /** | ||
| } | ||
| ): Promise<Array<Job>>; | ||
| ): Promise<Response_list_build_jobs_200>; | ||
@@ -1916,3 +2324,3 @@ /** | ||
| } | ||
| ): Promise<Array<string>>; | ||
| ): Promise<Response_list_tunnels_200>; | ||
@@ -1919,0 +2327,0 @@ /** |
@@ -20,10 +20,2 @@ "use strict"; | ||
| /** | ||
| * Create HMAC token to receive job assets | ||
| * | ||
| * @param {string} username username of user | ||
| * @param {string} key access key of user | ||
| * @param {string} jobId job id of job you want to get access to | ||
| * @return {string} hmac token | ||
| */ | ||
| function createHMAC(username, key, jobId) { | ||
@@ -30,0 +22,0 @@ const hmac = _crypto.default.createHmac('md5', `${username}:${key}`); |
@@ -281,3 +281,3 @@ SauceLabs Interface | ||
| <h3>Example:</h3> | ||
| <code>api.uploadApp(, { ...options })</code> | ||
| <code>api.uploadApp({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
@@ -394,3 +394,3 @@ <ul> <li><b>body</b>: No description available.</li> <li><b>App-Active</b>: If true makes uploaded application active one</li> <li><b>App-DisplayName</b>: Your custom display name</li> <li><b>App-Identifier</b>: Your custom unique identifier for your app</li> <li><b>App-Type</b>: Application type</li> </ul> </td> | ||
| <h3>Example:</h3> | ||
| <code>api.getSessionReports(, { ...options })</code> | ||
| <code>api.getSessionReports({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
@@ -490,3 +490,3 @@ <ul> <li><b>limit</b>: Max number of results per page</li> <li><b>offset</b>: Offset for pagination</li> <li><b>lastDays</b>: Number of days to report</li> <li><b>userId</b>: Your username.</li> </ul> </td> | ||
| <h3>Example:</h3> | ||
| <code>api.readBatchReport(, { ...options })</code> | ||
| <code>api.readBatchReport({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
@@ -500,3 +500,3 @@ <ul> <li><b>body</b>: No description available.</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| <h3>Example:</h3> | ||
| <code>api.junitStyleXmlReport(, { ...options })</code> | ||
| <code>api.junitStyleXmlReport({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
@@ -588,6 +588,24 @@ <ul> <li><b>body</b>: No description available.</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/</code><br> | ||
| Provides a list of paginated raw performance metrics for the logged user | ||
| <h3>Example:</h3> | ||
| <code>api.getPerformanceMetrics({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>page_url</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/</code><br> | ||
| No description available. | ||
| Provides performance metrics and job basic data for a given job_id | ||
| <h3>Example:</h3> | ||
| <code>api.getPerformanceMetrics(job_id)</code> | ||
| <code>api.getPerformanceMetricsByJobId(job_id, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>full</b>: When set to false, basic job data will be returned, excluding performance metrics</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/assert/</code><br> | ||
| Provides information if there is an outlier for the given job_id and metric | ||
| <h3>Example:</h3> | ||
| <code>api.assertPerformance(job_id, metric_names, order_index)</code> | ||
| </td> | ||
@@ -597,24 +615,23 @@ </tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/baseline/history/</code><br> | ||
| No description available. | ||
| <b>GET</b> <code>/metrics/{job_id}/baseline/</code><br> | ||
| Provides baseline based on metrics history, where the reference point is a given job_id | ||
| <h3>Example:</h3> | ||
| <code>api.getBaselineHistory(job_id, metric_names, order_index, { ...options })</code> | ||
| <code>api.getBaseline(job_id, metric_names, order_index, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>window_size</b>: No description available.</li> <li><b>limit</b>: No description available.</li> </ul> </td> | ||
| <ul> <li><b>regime_end</b>: No description available.</li> <li><b>regime_start</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/baseline/command/</code><br> | ||
| No description available. | ||
| <b>GET</b> <code>/metrics/{job_id}/baseline/reset/</code><br> | ||
| Returns true if a baseline was resetted for a give job_id | ||
| <h3>Example:</h3> | ||
| <code>api.getRecentBaselineHistory(job_id, metric_names, order_index, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>window_size</b>: No description available.</li> </ul> </td> | ||
| <code>api.hasBaselineReset(job_id)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PATCH</b> <code>/metrics/{job_id}/regime_acknowledge/</code><br> | ||
| No description available. | ||
| <b>POST</b> <code>/metrics/{job_id}/baseline/reset/</code><br> | ||
| Sets a reset point market at job_id, previous jobs will not be taken into account in calculating baseline | ||
| <h3>Example:</h3> | ||
| <code>api.acknowledgeRegime(job_id, body)</code> | ||
| <code>api.acknowledgeBaseline(job_id)</code> | ||
| </td> | ||
@@ -624,17 +641,50 @@ </tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/regressions/</code><br> | ||
| No description available. | ||
| <b>GET</b> <code>/metrics/{job_id}/discarded/</code><br> | ||
| Provides lists outliers marked as discarded | ||
| <h3>Example:</h3> | ||
| <code>api.assertPerformanceRegression(job_id, metric_names, { ...options })</code> | ||
| <code>api.getDiscardedOutliers(job_id, order_index)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>POST</b> <code>/metrics/{job_id}/discarded/</code><br> | ||
| Marks outlier for a given {job_id} as not relevant/flaky | ||
| <h3>Example:</h3> | ||
| <code>api.discardOutliers(job_id, order_index)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/history/</code><br> | ||
| Provides a list of raw performance metrics up to point where the reference is a given job_id and order_index | ||
| <h3>Example:</h3> | ||
| <code>api.getBaselineHistory(job_id, order_index, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>window_size</b>: No description available.</li> </ul> </td> | ||
| <ul> <li><b>limit</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/{job_id}/dataset/</code><br> | ||
| No description available. | ||
| <b>GET</b> <code>/metrics/{job_id}/regimes/</code><br> | ||
| Provides regimes per metric calculated for a set of jobs, where the reference point is a given job_id | ||
| <h3>Example:</h3> | ||
| <code>api.getPerformanceDataset(job_id, metric_names)</code> | ||
| <code>api.getRegimes(job_id, metric_names, order_index, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>include_baseline</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>POST</b> <code>/metrics/{job_id}/regimes/acknowledge/</code><br> | ||
| Acknowledge regime. Confirm values in new regime are acceptable. | ||
| <h3>Example:</h3> | ||
| <code>api.acknowledgeRegime(job_id, order_index)</code> | ||
| </td> | ||
| </tr> | ||
| </tbody></table> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/swagger/</code><br> | ||
| Provides json documentation for the performance API | ||
| <h3>Example:</h3> | ||
| <code>api.getApiDefinition()</code> | ||
| </td> | ||
| </tr> | ||
| </tbody></table> |
| { | ||
| "name": "saucelabs", | ||
| "version": "2.3.0", | ||
| "version": "3.0.0", | ||
| "author": "Christian Bromann <christian@saucelabs.com>", | ||
@@ -5,0 +5,0 @@ "description": "A wrapper around Sauce Labs REST API", |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by7.91%
294283
- Lines of code
- increased by7.05%
8865
No dependency changes