Skip to content

Commit

Permalink
Added Local Testing APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
@shirish87
shirish87 committed Jan 31, 2024
1 parent 089f912 commit 4e953f8
Show file tree
Hide file tree
Showing 9 changed files with 642 additions and 5 deletions.
5 changes: 4 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ BROWSERSTACK_KEY=<your-access-key>
import { BrowserStack } from 'browserstack-client';
// BrowserStack JavaScript Testing API
const apiClient = new BrowserStack.Client();
const jsTestingClient = new BrowserStack.Client();
// BrowserStack Automate API
const automateClient = new BrowserStack.AutomateClient();
Expand All @@ -40,6 +40,9 @@ const appAutomateClient = new BrowserStack.AppAutomateClient();
// BrowserStack Screenshots API
const screenshotsClient = new BrowserStack.ScreenshotsClient();
// BrowserStack Local Testing API
const localTestingClient = new BrowserStack.LocalTestingClient();
```


Expand Down
275 changes: 275 additions & 0 deletions openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3484,6 +3484,229 @@ paths:
"500":
$ref: '#/components/schemas/5xx.InternalServerError'

# Local Testing APIs
/local/v1/list:
get:
summary: Fetches list of recent binary instances
description: >-
Fetches list of recent binary instances for local testing.
Note that the binary should have been started with the --enable-logging-for-api parameter.
operationId: getLocalBinaryInstances
parameters:
- name: auth_token
in: query
required: true
schema:
type: string
description: "Your BrowserStack access token"
example: "ACCESS_TOKEN"
- name: last
in: query
schema:
type: number
description: "The number of recent binary instances to be listed. Maximum value: 100. Default value: 20."
default: 20
- name: state
in: query
schema:
type: string
description: "Filter binary instances by state. Accepted values: running, all. Default value: running."
enum: [running, all]
default: running
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
required: [api_version, meta_data, instances]
properties:
api_version:
type: string
description: "API version"
example: "v1"
meta_data:
type: object
description: "Metadata"
properties:
params:
type: object
description: "Parameters"
additionalProperties: true
additionalProperties: true
instances:
type: array
items:
type: object
$ref: "#/components/schemas/LocalBinaryInstance"

"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'

/local/v1/{localInstanceId}:
get:
summary: Fetches details of a Local binary instance
description: >-
Fetches details of a Local binary instance used for local testing.
Note that the binary should have been started with the --enable-logging-for-api parameter.
operationId: getLocalBinaryInstance
parameters:
- name: localInstanceId
in: path
required: true
schema:
type: string
description: "The local instance ID"
example: "QUERTY1"
- name: auth_token
in: query
required: true
schema:
type: string
description: "Your BrowserStack access token"
example: "ACCESS_TOKEN"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
required: [api_version, meta_data, instances]
properties:
api_version:
type: string
description: "API version"
example: "v1"
meta_data:
type: object
description: "Metadata"
properties:
params:
type: object
description: "Parameters"
additionalProperties: true
additionalProperties: true
instances:
type: array
items:
type: object
$ref: "#/components/schemas/LocalBinaryInstance"

"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'

delete:
summary: Disconnect a Local binary instance
description: Disconnect a Local binary instance
operationId: disconnectLocalBinaryInstance
parameters:
- name: localInstanceId
in: path
required: true
schema:
type: string
description: "The local instance ID"
example: "QUERTY1"
- name: auth_token
in: query
required: true
schema:
type: string
description: "Your BrowserStack access token"
example: "ACCESS_TOKEN"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
required: [api_version, meta_data, message]
properties:
api_version:
type: string
description: "API version"
example: "v1"
meta_data:
type: object
description: "Metadata"
properties:
params:
type: object
description: "Parameters"
additionalProperties: true
additionalProperties: true
message:
type: string
description: "QUERTY1 successfully disconnected"

"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'

/browserstack-local/BrowserStackLocal-{osArch}.zip:
get:
summary: Download the BrowserStackLocal binary zip file
description: Download the BrowserStackLocal binary zip file
operationId: downloadLocalBinary
parameters:
- name: osArch
in: path
required: true
schema:
type: string
description: "OS and architecture"
enum:
- "darwin-x64"
- "linux-x64"
- "linux-ia32"
- "win32"
- "alpine"
example: "darwin-x64"
responses:
"200":
description: Successful operation
content:
application/zip:
schema:
type: string
format: binary

"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'


components:
Expand Down Expand Up @@ -4426,6 +4649,58 @@ components:
description: "Timestamp at which the screenshot was taken"
example: "2013-03-14 16:25:45 UTC"

LocalBinaryInstance:
type: object
required: [id, email, lastActiveOn, startTime, localIdentifier]
properties:
id:
type: string
description: "Unique identifier for the Local instance."
example: "QUERTY1"
email:
type: string
description: "User account that started the Local instance."
example: "john@browserstack.com"
hostname:
type: string
description: "Hostname for the machine running the Local instance."
example: "my-local-box"
lastActiveOn:
type: string
description: "Timestamp at which the Local instance was last active."
example: "2013-03-14 16:25:45 UTC"
startTime:
type: string
description: "Timestamp at which the Local instance was started."
example: "2013-03-14 16:25:45 UTC"
endTime:
type: string
description: "Timestamp at which the Local instance was terminated."
example: "2013-03-14 16:25:45 UTC"
disconnectReason:
type: string
description: "Reason for termination of the Local instance."
example: "User terminated the instance."
commandLineParams:
type: string
description: "Command line parameters used to start the Local instance."
example: "--key <access_key> --enable-logging-for-api --local-identifier <local_identifier>"
localIdentifier:
type: string
description: "Identifier for the Local instance."
example: "4207442b2b0567368956dba064c22a3235a76214"
public-IP:
type: string
description: "Public IP address of the machine running the Local instance."
example: "8.8.4.4"
privateIP:
type: array
items:
type: string
description: "Private IP address of the machine running the Local instance."
example: ["127.0.0.1", "10.100.100.1"]


400.BadRequest:
description: Bad request.

Expand Down
11 changes: 11 additions & 0 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"vitest": "1.2.1"
},
"dependencies": {
"fflate": "^0.8.1",
"openapi-fetch": "^0.8.2"
},
"repository": {
Expand Down
Loading

0 comments on commit 4e953f8

Please sign in to comment.