From 0ef39d49733d7423ada98d789a07d6a1ae6b84ab Mon Sep 17 00:00:00 2001 From: Dan Slov Date: Tue, 13 Aug 2024 13:21:03 -0700 Subject: [PATCH] updating doc --- docs/interface.md | 240 ------------------------- tests/__snapshots__/index.test.js.snap | 7 - 2 files changed, 247 deletions(-) diff --git a/docs/interface.md b/docs/interface.md index eb96d76d..d373713c 100644 --- a/docs/interface.md +++ b/docs/interface.md @@ -265,246 +265,6 @@ The following commands are available via package or cli tool:

Options

- - - PUT /v1/appium/session/{sessionId}/skiptest
- Report the result of a test as skipped. -

Example:

- api.markTestAsSkippedDeprecated(sessionId) - - - - - PUT /v1/appium/session/{sessionId}/test
- Report the result of a test. -

Example:

- api.updateTestDeprecated(sessionId, { ...options }) -

Options

- - - - - PUT /v1/appium/suites/{batchId}
- Updates the properties of a suite. -

Example:

- api.updateSuiteDeprecated(suiteId, { ...options }) -

Options

- - - - - GET /v1/appium/suites/{batchId}/deviceIds
- Returns the IDs of the devices which you had selected for the specified suite. -

Example:

- api.readDeviceIdsDeprecated(suiteId) - - - - - POST /v1/appium/suites/{batchId}/reports/start
- Start a new suite execution including its test executions. -

Example:

- api.startSuiteDeprecated(suiteId, { ...options }) -

Options

- - - - - PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/finish
- Marks all test executions contained in the specified suite execution as finished. -

Example:

- api.finishSuiteDeprecated(suiteId, batchReportId) - - - - - PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish
- Sets the status of the specific test execution and marks it as finished. -

Example:

- api.finishTestReportDeprecated(suiteId, suiteReportId, testReportId, { ...options }) -

Options

- - - - - PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip
- Mark test execution as skipped -

Example:

- api.skipTestReportDeprecated(suiteId, suiteReportId, testReportId) - - - - - GET /v1/devices
- Returns a list containing all devices, including those not currently available for testing -

Example:

- api.getDescriptorsDeprecated() - - - - - GET /v1/devices/all
- Returns a list containing all devices, including those not currently unavailable for testing. -This endpoint requires API Key authentication and will also return your private devices. -

Example:

- api.getDescriptorsApiDeprecated() - - - - - GET /v1/devices/all/available
- Returns a list containing the IDs of all devices currently available for testing. -This endpoint requires API Key authentication and will also return your private devices. -

Example:

- api.getAvailableDescriptorIdsApiDeprecated() - - - - - GET /v1/devices/available
- Returns a list containing the IDs of all devices currently available for testing -

Example:

- api.getAvailableDescriptorIdsDeprecated() - - - - - GET /v1/devices/reports
- The session history reports provide information about user sessions. This includes device usage and test reports. By default reports of the last 30 days will be retrieved - limited to a maximum of 50 reports. -If the authenticated user is the owner of the account, session reports of the entire team will be retrieved. Team members can only retrieve their own session history. This endpoint requires Password authentication. -

Example:

- api.getSessionReports({ ...options }) -

Options

- - - - - GET /v1/devices/{deviceDescriptorId}
- Returns information for a particular device. -This endpoint requires API Key authentication. -

Example:

- api.getDescriptorDeprecated(deviceId) - - - - - GET /v1/devices/{deviceDescriptorId}/status
- Returns a list containing device status infos for all device instances with the specified device ID on all pools. -This endpoint requires API Key authentication and will also return your private devices. -

Example:

- api.getDeviceStatusInfosDeprecated(deviceId) - - - - - PUT /v2/appium/session/{sessionId}/skiptest
- Report the result of a test as skipped. -

Example:

- api.markTestAsSkipped(sessionId) - - - - - PUT /v2/appium/session/{sessionId}/test
- Report the result of a test. -

Example:

- api.updateTest(sessionId, { ...options }) -

Options

- - - - - PUT /v2/appium/suites/{batchId}
- Updates the properties of a suite. -

Example:

- api.updateSuite(suiteId, { ...options }) -

Options

- - - - - GET /v2/appium/suites/{batchId}/deviceIds
- Returns the IDs of the devices which you had selected for the specified suite. -

Example:

- api.readDeviceIds(suiteId) - - - - - POST /v2/appium/suites/{batchId}/reports/start
- Start a new suite execution including its test executions. -

Example:

- api.startSuite(suiteId, { ...options }) -

Options

- - - - - PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/finish
- Marks all test executions contained in the specified suite execution as finished. -

Example:

- api.finishSuite(suiteId, batchReportId) - - - - - PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish
- Sets the status of the specific test execution and marks it as finished. -

Example:

- api.finishTestReport(suiteId, suiteReportId, testReportId, { ...options }) -

Options

- - - - - PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip
- Mark test execution as skipped -

Example:

- api.skipTestReport(suiteId, suiteReportId, testReportId) - - - - - GET /v2/batchReports/{batchReportId}
- Returns the test report of a suite -

Example:

- api.readBatchReport({ ...options }) -

Options

- - - - - GET /v2/batchReports/{batchReportId}/xml
- Returns the test report of a suite as XML -

Example:

- api.junitStyleXmlReport({ ...options }) -

Options

- - - - - GET /v2/devices
- Returns a list per data center containing all devices, including private devices and those not currently available for testing. This endpoint requires API Key authentication. -

Example:

- api.getDescriptors() - - - - - GET /v2/devices/available
- Returns a list per data center containing the IDs of all devices currently available for testing, including private devices. This endpoint requires API Key authentication. -

Example:

- api.getAvailableDescriptorIds() - - - - - GET /v2/devices/{deviceDescriptorId}
- Returns information for a particular device per data center. This endpoint requires API Key authentication. -

Example:

- api.getDescriptor(deviceId) - - GET /v2/logs/{testReportId}/appium
diff --git a/tests/__snapshots__/index.test.js.snap b/tests/__snapshots__/index.test.js.snap index 724f1c4a..63ae6800 100644 --- a/tests/__snapshots__/index.test.js.snap +++ b/tests/__snapshots__/index.test.js.snap @@ -1,12 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`should contain custom headers 1`] = ` -{ - "Authorization": "Basic Zm9vOmJhcg==", - "user-agent": "foo", -} -`; - exports[`should get builds failed jobs 1`] = ` [ [