appium-mcp 1.8.10 → 1.8.12

package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/index.md

@@ -1,30 +0,0 @@
----
-hide:
-  - toc
-
-title: API Endpoints
----
-
-Here you can find various API endpoints exposed by the main Appium module through its base driver,
-as well as the endpoints added or modified by official plugins.
-
-Since all Appium drivers inherit the Appium base driver, they support all of its endpoints as well,
-but may additionally define endpoints of their own. Refer to the documentation of your
-[Appium driver](../../ecosystem/drivers.md) to learn about its specific endpoints.
-
-The recommended way of calling these API endpoints is through your [Appium client](../../ecosystem/clients.md).
-Refer to the documentation of your client for the exact commands used to invoke specific endpoints.
-
-All endpoints are grouped by their protocol, with an additional group for plugin endpoints:
-
-<div class="grid cards" markdown>
-
--   [__WebDriver Protocol__](./webdriver.md)
--   [__WebDriver BiDi Protocol__](./bidi.md)
--   [__JSON Wire Protocol__](./jsonwp.md)
--   [__Mobile JSON Wire Protocol__](./mjsonwp.md)
--   [__Appium Protocol__](./appium.md)
--   [__Other Protocols__](./others.md)
--   [__Endpoints Used by Official Plugins__](./plugins.md)
-
-</div>

package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/jsonwp.md

@@ -1,214 +0,0 @@
----
-title: JSON Wire Protocol
----
-<style>
-  ul[data-md-component="toc"] .md-nav {
-    display: none;
-  }
-</style>
-
-The following is a list of legacy [JSON Wire Protocol (JSONWP)](https://www.selenium.dev/documentation/legacy/json_wire_protocol/)
-endpoints supported in Appium.
-
-### getSession
-
-```
-GET /session/:sessionId
-```
-
-> JSONWP documentation: [/session/:sessionId](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionid)
-
-Retrieves the capabilities of the current session.
-
-Appium implements a modified version of this endpoint. If the `appium:eventTimings` capability is
-set to `true`, the returned result will additionally include the `events` key, whose value contains
-the event history and timings.
-
-!!! warning "Deprecated"
-
-    For retrieving capabilities, please use [`getAppiumSessionCapabilities`](./appium.md#getappiumsessioncapabilities).<br />
-    For retrieving event history, please use [`getLogEvents`](./appium.md#getlogevents).
-
-#### Response
-
-`Capabilities` - an object containing the session capabilities, and the event history (if applicable)
-
-### availableIMEEngines
-
-```
-GET /session/:sessionId/ime/available_engines
-```
-
-> JSONWP documentation: [/session/:sessionId/ime/available_engines](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidimeavailable_engines)
-
-Retrieves all IME (input method editor) engines available on the device under test.
-
-!!! warning "Deprecated"
-
-    In the future, this endpoint will be moved to the [UiAutomator2 and Espresso drivers](../../ecosystem/drivers.md)
-
-#### Response
-
-`string[]` - a list of available IME engines
-
-### getActiveIMEEngine
-
-```
-GET /session/:sessionId/ime/active_engine
-```
-
-> JSONWP documentation: [/session/:sessionId/ime/active_engine](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidimeactive_engine)
-
-Retrieves the name of the active IME engine.
-
-!!! warning "Deprecated"
-
-    In the future, this endpoint will be moved to the UiAutomator2 and Espresso drivers
-
-#### Response
-
-`string` - the name of the active IME engine
-
-### isIMEActivated
-
-```
-GET /session/:sessionId/ime/activated
-```
-
-> JSONWP documentation: [/session/:sessionId/ime/activated](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidimeactivated)
-
-Determines if IME input is available and active.
-
-!!! warning "Deprecated"
-
-    In the future, this endpoint will be moved to the UiAutomator2 and Espresso drivers
-
-#### Response
-
-`boolean` - `true` if IME is active, otherwise `false`
-
-### deactivateIMEEngine
-
-```
-POST /session/:sessionId/ime/deactivate
-```
-
-> JSONWP documentation: [/session/:sessionId/ime/deactivate](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidimedeactivate)
-
-Deactivates the currently active IME engine.
-
-!!! warning "Deprecated"
-
-    In the future, this endpoint will be moved to the UiAutomator2 and Espresso drivers
-
-#### Response
-
-`null`
-
-### activateIMEEngine
-
-```
-POST /session/:sessionId/ime/activate
-```
-
-> JSONWP documentation: [/session/:sessionId/ime/activate](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidimeactivate)
-
-Activates an IME engine.
-
-!!! warning "Deprecated"
-
-    In the future, this endpoint will be moved to the UiAutomator2 and Espresso drivers
-
-#### Parameters
-
-|Name|Description|Type|
-|--|--|--|
-|`engine`|Name of the IME engine to activate|string|
-
-#### Response
-
-`null`
-
-### getOrientation
-
-```
-GET /session/:sessionId/orientation
-```
-
-> JSONWP documentation: [/session/:sessionId/orientation](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidorientation)
-
-Retrieves the current orientation of the device under test.
-
-#### Response
-
-`string` - either `PORTRAIT` or `LANDSCAPE`
-
-### setOrientation
-
-```
-POST /session/:sessionId/orientation
-```
-
-> JSONWP documentation: [/session/:sessionId/orientation](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidorientation)
-
-Sets the orientation of the device under test.
-
-#### Parameters
-
-|Name|Description|Type|
-|--|--|--|
-|`orientation`|New device orientation. Supported values are `PORTRAIT` or `LANDSCAPE`.|string|
-
-#### Response
-
-`null`
-
-### getGeoLocation
-
-```
-GET /session/:sessionId/location
-```
-
-> JSONWP documentation: [/session/:sessionId/location](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidlocation)
-
-Retrieves the current location of the device under test.
-
-!!! warning "Deprecated"
-
-    Please use driver-specific extension methods such as `mobile: getGeoLocation` or
-    `mobile: getSimulatedLocation`
-
-#### Response
-
-`Location` - an object with the following properties:
-
-|Name|Description|Type|
-|--|--|--|
-|`altitude`|Altitude of the device location|number|
-|`latitude`|Latitude of the device location|number|
-|`longitude`|Longitude of the device location|number|
-
-### setGeoLocation
-
-```
-POST /session/:sessionId/location
-```
-
-> JSONWP documentation: [/session/:sessionId/location](https://www.selenium.dev/documentation/legacy/json_wire_protocol/#sessionsessionidlocation)
-
-Sets the current location of the device under test.
-
-!!! warning "Deprecated"
-
-    Please use driver-specific extension methods such as `mobile: setGeoLocation` or
-    `mobile: setSimulatedLocation`
-
-#### Parameters
-
-|Name|Description|Type|
-|--|--|--|
-|`location`|New device latitude, longitude and altitude|[`Location`](#response_6)|
-
-#### Response
-
-`null`

package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/mjsonwp.md

@@ -1,151 +0,0 @@
----
-title: Mobile JSON Wire Protocol
----
-<style>
-  ul[data-md-component="toc"] .md-nav {
-    display: none;
-  }
-</style>
-
-The following is a list of legacy [Mobile JSON Wire Protocol (MJSONWP)](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)
-endpoints supported in Appium.
-
-### getRotation
-
-```
-GET /session/:sessionId/rotation
-```
-
-> MJSONWP documentation: [Device Rotation](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation)
-
-Retrieves the current spatial orientation of the device under test.
-
-#### Response
-
-`Rotation` - an object with the following properties:
-
-|Name|Description|Type|
-|--|--|--|
-|`x`|Degrees by which the device is rotated on its X axis|number|
-|`y`|Degrees by which the device is rotated on its Y axis|number|
-|`z`|Degrees by which the device is rotated on its Z axis|number|
-
-### setRotation
-
-```
-POST /session/:sessionId/rotation
-```
-
-> MJSONWP documentation: [Device Rotation](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation)
-
-Sets the spatial orientation of the device under test.
-
-#### Parameters
-
-|Name|Description|Type|
-|--|--|--|
-|`x`|Degrees by which the device is rotated on its X axis|number|
-|`y`|Degrees by which the device is rotated on its Y axis|number|
-|`z`|Degrees by which the device is rotated on its Z axis|number|
-
-#### Response
-
-`null`
-
-### getCurrentContext
-
-```
-GET /session/:sessionId/context
-```
-
-> MJSONWP documentation: [Webviews and Other Contexts](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
-
-Retrieves the active application context.
-
-#### Response
-
-`string` - the name of the active context
-
-### setContext
-
-```
-POST /session/:sessionId/context
-```
-
-> MJSONWP documentation: [Webviews and Other Contexts](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
-
-Sets an application context as the active context.
-
-#### Parameters
-
-|Name|Description|Type|
-|--|--|--|
-|`name`|Name of the context to set as the active one|string|
-
-#### Response
-
-`null`
-
-### getContexts
-
-```
-GET /session/:sessionId/contexts
-```
-
-> MJSONWP documentation: [Webviews and Other Contexts](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
-
-Retrieves all available application contexts.
-
-#### Response
-
-`string[]` - the names of available contexts
-
-### getNetworkConnection
-
-```
-GET /session/:sessionId/network_connection
-```
-
-> MJSONWP documentation: [Device Modes](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes)
-
-Retrieves the current state of network types (data, Wi-Fi, airplane mode).
-
-!!! warning "Deprecated"
-
-    Please use driver-specific extension methods such as `mobile: getConnectivity`
-
-#### Response
-
-`NetworkConnectionState` - a number indicating the current network state:
-
-|Value|Data|Wi-Fi|Airplane Mode|
-|--|--|--|--|
-|`0`|OFF|OFF|OFF|
-|`1`|OFF|OFF|ON|
-|`2`|OFF|ON|OFF|
-|`4`|ON|OFF|OFF|
-|`6`|ON|ON|OFF|
-
-### setNetworkConnection
-
-```
-POST /session/:sessionId/network_connection
-```
-
-> MJSONWP documentation: [Device Modes](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes)
-
-Sets the state of network types (data, Wi-Fi, airplane mode).
-
-!!! warning "Deprecated"
-
-    Please use driver-specific extension methods such as `mobile: setConnectivity`
-
-#### Parameters
-
-|<div style="width:6em">Name</div>|Description|<div style="width:18em">Type</div>|
-|--|--|--|
-|`parameters`|Object containing the `type` key, whose value is the desired network state|`{"type": `[`NetworkConnectionState`](#response_5)`}`|
-
-#### Response
-
-[`NetworkConnectionState`](#response_5) - the new network state