From 3af2ec37ecd4493f23c0009fd93c618964071a08 Mon Sep 17 00:00:00 2001 From: Vibhaj Rajan Date: Tue, 15 Sep 2015 15:16:06 +0530 Subject: [PATCH 1/3] added video recording --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 11e8f83..1666bba 100644 --- a/README.md +++ b/README.md @@ -292,6 +292,9 @@ Optional name of the build the session is running under. #### (project) Optional name of the project the build is under. +#### (browserstack.video) +Optional flag to enable video recording in your test. + ### Response The response will be returned when the worker has been setup and initialized. This involves loading the HTML data or navigating to the url given depending on the setup parameters. Use the id returned to perform any further communications etc. From 6459d2b967ea78ff6c918af3b278c07a200d96f8 Mon Sep 17 00:00:00 2001 From: Irfan Wadia Date: Wed, 20 Apr 2016 13:38:10 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1666bba..0c63be6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +**Note:** This version of the BrowserStack API has been deprecated. Please use [BrowserStack API v4.0](https://github.com/browserstack/api) # API Overview The following denotes the HTTP-based API for [BrowserStack](http://www.browserstack.com). It provides browser-as-a-service for automated cross-browser testing. The goal is to provide a simple service which can easily be used by any browser testing framework. From 94ce8aa257330b4086c544837d7768c37d1e20d1 Mon Sep 17 00:00:00 2001 From: Archish Thakkar Date: Tue, 18 Aug 2020 21:38:48 +0530 Subject: [PATCH 3/3] Updated README removed all true param --- README.md | 235 ++++++++++++++++++++---------------------------------- 1 file changed, 88 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index 0c63be6..2cddec4 100644 --- a/README.md +++ b/README.md @@ -70,83 +70,59 @@ Fetches all available browsers. { 'Windows': { - '7': + '10': [ - { - browser: 'ie', - browser_version: 8.0, - }, - { - browser: 'firefox', - browser_version: 2.0, - }, - { - browser: 'chrome', - browser_version: 14.0, - } ... - ], - 'XP': - [ - { - browser: 'ie', - browser_version: 7.0, - }, - { - browser: 'firefox', - browser_version: 10.0, - }, - { - browser: 'chrome', - browser_version: 14.0, - } ... + { + "browser": "chrome", + "browser_version": "83.0" + }, + { + "browser": "chrome", + "browser_version": "84.0" + }, + { + "browser": "chrome", + "browser_version": "85.0 beta" + }, + { + "browser": "ie", + "browser_version": "11.0" + }, + { + "browser": "edge", + "browser_version": "insider preview" + }... ], }, 'OS X': { - 'Snow Leopard': + 'Catalina': [ - { - browser: 'firefox', - browser_version: 11.0, - }, - { - browser: 'chrome', - browser_version: 14.0, - }, ... + { + "browser": "chrome", + "browser_version": "85.0 beta" + }, + { + "browser": "edge", + "browser_version": "85.0 beta" + }, + { + "browser": "safari", + "browser_version": "13.1" + }, + { + "browser": "firefox", + "browser_version": "79.0" + }, + { + "browser": "firefox", + "browser_version": "80.0 beta" + }... ], - 'Lion': - [ - { - browser: 'firefox', - browser_version: 11.0, - }, - { - browser: 'chrome', - browser_version: 14.0, - } ... - ], - }, - 'ios': - { - '4.0': - [ - { - browser: "Mobile Safari", - browser_version: null, - devices: ["iPhone 4"], - } - ], - '6.0': - [ - { - browser: "Mobile Safari", - browser_version: null, - devices: ["iPhone 4S (6.0)", "iPhone 5", "iPad 3rd (6.0)"], - } - ] + }... }, } -``` +``` A flat parameter can also be passed to get browsers in a flat structure @@ -154,98 +130,63 @@ A flat parameter can also be passed to get browsers in a flat structure ### Output -```javascript -[ -{ - device: null, - os_version: "8", - os: "Windows", - browser_version: "5.1", - browser: "safari" -}, -{ - device: null, - os_version: "8", - os: "Windows", - browser_version: "16.0", - browser: "firefox" -}, -{ - device: null, - os_version: "8", - os: "Windows", - browser_version: "17.0", - browser: "firefox" -}, -{ - device: null, - os_version: "8", - os: "Windows", - browser_version: "18.0", - browser: "firefox" -}, -{ - device: null, - os_version: "8", - os: "Windows", - browser_version: "10.0", - browser: "ie" -}.... -``` - -You can get beta/dev versions of browsers by using "all" parameter: - - GET /browsers?all=true - -### Output - ```javascript { 'Windows': { - 'XP': + '10': [ - { - browser: 'ie', - browser_version: 7.0, - }, - { - browser: 'firefox', - browser_version: '28.0 beta', - }, - { - browser: 'chrome', - browser_version: 14.0, - } ... + { + "browser": "chrome", + "browser_version": "83.0" + }, + { + "browser": "chrome", + "browser_version": "84.0" + }, + { + "browser": "chrome", + "browser_version": "85.0 beta" + }, + { + "browser": "ie", + "browser_version": "11.0" + }, + { + "browser": "edge", + "browser_version": "insider preview" + }... ], }, 'OS X': { - 'Snow Leopard': + 'Catalina': [ - { - browser: 'firefox', - browser_version: 11.0, - }, - { - browser: 'chrome', - browser_version: '27.0 beta', - }, ... - ], - 'Lion': - [ - { - browser: 'firefox', - browser_version: 11.0, - }, - { - browser: 'chrome', - browser_version: 14.0, - } ... + { + "browser": "chrome", + "browser_version": "85.0 beta" + }, + { + "browser": "edge", + "browser_version": "85.0 beta" + }, + { + "browser": "safari", + "browser_version": "13.1" + }, + { + "browser": "firefox", + "browser_version": "79.0" + }, + { + "browser": "firefox", + "browser_version": "80.0 beta" + }... ], + }... }, } -``` +``` ## Create a New Browser Worker A browser worker is simply a new browser instance. A user can start multiple browser worker at a time. All browser workers when created are pushed in a queue and they run when their turn comes. We make sure that your browser worker starts running as soon as possible. Your testing time is calculated from the time when browser worker starts running.