[DOCS] Fixes for Commands -> Device (#9451)

* [DOCS] Fixes for `Commands -> Device` * Replace pipelines with quotes in json_parameters section * Add missed keys commands
2026-01-24 11:18:55 -06:00 · 2017-10-16 16:15:18 +03:00
parent ee872e6362
commit 024d7ac7bb
57 changed files with 155 additions and 146 deletions
--- a/commands-yml/commands/device/activity/start-activity.yml
+++ b/commands-yml/commands/device/activity/start-activity.yml
@@ -5,7 +5,7 @@ short_description: Get the name of the current Android activity
 example_usage:
  java:
    |
-      driver.currentActivity(new Activity("com.example", "ActivityName"));
+      driver.startActivity(new Activity("com.example", "ActivityName"));
  python:
    |
      self.driver.start_activity("com.example", "ActivityName");
--- a/commands-yml/commands/device/app/background-app.yml
+++ b/commands-yml/commands/device/app/background-app.yml
@@ -65,7 +65,7 @@ endpoint:
  json_parameters:
    - name: seconds
      type: number
-      description: How long to run app in background. Minimum resolution time is one second.
+      description: How long to run app in background.

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/commands-yml/commands/device/files/pull-file.yml
+++ b/commands-yml/commands/device/files/pull-file.yml
@@ -58,7 +58,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /wd/hub/session/:session_id/device/pull_file
+  url: /wd/hub/session/:session_id/appium/device/pull_file
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/files/pull-folder.yml
+++ b/commands-yml/commands/device/files/pull-folder.yml
@@ -66,10 +66,10 @@ endpoint:
  json_parameters:
    - name: path
      type: string
-      description: Path on the device to pull file from
+      description: Path to an entire folder on the device
  response:
    - type: string
-      description: Contents of file in base64
+      description: A string of Base64 encoded data, representing a zip archive of the contents of the requested folder.

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/commands-yml/commands/device/files/push-file.yml
+++ b/commands-yml/commands/device/files/push-file.yml
@@ -59,7 +59,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /wd/hub/session/:session_id/device/push_file
+  url: /wd/hub/session/:session_id/appium/device/push_file
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/interactions/is-locked.yml
+++ b/commands-yml/commands/device/interactions/is-locked.yml
@@ -34,8 +34,8 @@ client_docs:
 # Driver support by platform
 driver_support:
  ios:
-    xcuitest: true
-    uiautomation: true
+    xcuitest: false
+    uiautomation: false
  android:
    uiautomator2: true
    uiautomator: true
--- a/commands-yml/commands/device/interactions/lock.yml
+++ b/commands-yml/commands/device/interactions/lock.yml
@@ -65,6 +65,10 @@ endpoint:
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
+  json_parameters:
+    - name: seconds
+      type: number
+      description: How long to lock the screen (iOS only).

 # Links to specifications. Should link to at least one specification
 specifications:
--- a/commands-yml/commands/device/interactions/shake.yml
+++ b/commands-yml/commands/device/interactions/shake.yml
@@ -67,4 +67,4 @@ endpoint:

 # Links to specifications. Should link to at least one specification
 specifications:
-  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L292
+  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L301
--- a/commands-yml/commands/device/interactions/unlock.yml
+++ b/commands-yml/commands/device/interactions/unlock.yml
@@ -37,8 +37,8 @@ client_docs:
 # Driver support by platform
 driver_support:
  ios:
-    xcuitest: true
-    uiautomation: true
+    xcuitest: false
+    uiautomation: false
  android:
    uiautomator2: true
    uiautomator: true
--- a/commands-yml/commands/device/keys/hide-keyboard.yml
+++ b/commands-yml/commands/device/keys/hide-keyboard.yml
@@ -17,7 +17,7 @@ example_usage:
      driver.hideDeviceKeyboard();
  ruby:
    |
-      @driver.find_element(:accessibility_id, 'SomeAccessibilityID')
+      @driver.hide_keyboard()
  php:
    |
      // TODO PHP sample
@@ -58,7 +58,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /wd/hub/session/:session_id/element
+  url: /wd/hub/session/:session_id/appium/device/hide_keyboard
  method: 'POST'
  url_parameters:
    - name: session_id
@@ -66,7 +66,7 @@ endpoint:
  json_parameters:
    - name: strategy
      type: string
-      description: Hide keyboard strategy (optional)
+      description: Hide keyboard strategy (optional, UIAutomation only). Available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'.
    - name: key
      type: string
      description: Key (optional)
--- a/commands-yml/commands/device/keys/is-keyboard-shown.yml
+++ b/commands-yml/commands/device/keys/is-keyboard-shown.yml
@@ -5,7 +5,7 @@ short_description: Whether or not the soft keyboard is shown
 example_usage:
  java:
    |
-      boolean isKeyboardShown = driver.manager().isKeyboardShown();
+      boolean isKeyboardShown = driver.isKeyboardShown();
  ruby:
    |
      @driver.is_keyboard_shown();
@@ -38,24 +38,14 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /wd/hub/session/:session_id/element
-  method: 'POST'
+  url: /wd/hub/session/:session_id/appium/device/is_keyboard_shown
+  method: 'GET'
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
-  json_parameters:
-    - name: strategy
-      type: string
-      description: Hide keyboard strategy (optional)
-    - name: key
-      type: string
-      description: Key (optional)
-    - name: keyCode
-      type: string
-      description: Key code (optional)
-    - name: keyName
-      type: string
-      description: Key name (optional)
+  response:
+    - type: boolean
+      description: True if the keyboard is shown.

 # Links to specifications. Should link to at least one specification
 specifications:
--- a/commands-yml/commands/device/keys/long-press-keycode.yml
+++ b/commands-yml/commands/device/keys/long-press-keycode.yml
@@ -5,7 +5,7 @@ short_description: Press and hold a particular key code on the device
 example_usage:
  java:
    |
-      driver.longPressKeyCode(10);
+      driver.longPressKeyCode(AndroidKeyCode.HOME);
  python:
    |
      self.driver.long_press_keycode(10);
@@ -63,7 +63,7 @@ endpoint:
  json_parameters:
    - name: keycode
      type: number
-      description: \[Key code](http://developer.android.com/reference/android/view/KeyEvent.html) pressed on the device
+      description: Key code pressed on the device. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html).
    - name: metastate
      type: number
      description: Metastate for the keypress
--- a/commands-yml/commands/device/keys/press-keycode.yml
+++ b/commands-yml/commands/device/keys/press-keycode.yml
@@ -5,7 +5,7 @@ short_description: Press a particular key on the device
 example_usage:
  java:
    |
-      driver.pressKeyCode(10);
+      driver.pressKeyCode(AndroidKeyCode.SPACE, AndroidKeyMetastate.META_SHIFT_ON);
  python:
    |
      self.driver.press_keycode(10);
@@ -63,7 +63,7 @@ endpoint:
  json_parameters:
    - name: keycode
      type: number
-      description: \[Key code](http://developer.android.com/reference/android/view/KeyEvent.html) pressed on the device
+      description: Key code pressed on the device. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html).
    - name: metastate
      type: number
      description: Metastate for the keypress
--- a/commands-yml/commands/device/network/gsm-call.yml
+++ b/commands-yml/commands/device/network/gsm-call.yml
@@ -33,15 +33,15 @@ driver_support:
 client_support:
  java: false
  python: false
-  ruby: true
-  php: true
-  csharp: true
+  ruby: false
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/gsm_call
+  url: /session/:session_id/appium/device/gsm_call
  method: POST
  url_parameters:
    - name: session_id
@@ -50,9 +50,9 @@ endpoint:
    - name: phoneNumber
      type: string
      description: The phone number to call to
-    - name: message
+    - name: action
      type: string
-      description: The action
+      description: The action - 'call', 'accept', 'cancel', 'hold'.

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/commands-yml/commands/device/network/gsm-signal.yml
+++ b/commands-yml/commands/device/network/gsm-signal.yml
@@ -33,15 +33,15 @@ driver_support:
 client_support:
  java: false
  python: false
-  ruby: true
-  php: true
-  csharp: true
+  ruby: false
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/gsm_signal
+  url: /session/:session_id/appium/device/gsm_signal
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/network/gsm-voice.yml
+++ b/commands-yml/commands/device/network/gsm-voice.yml
@@ -33,15 +33,15 @@ driver_support:
 client_support:
  java: false
  python: false
-  ruby: true
-  php: true
-  csharp: true
+  ruby: false
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/gsm_voice
+  url: /session/:session_id/appium/device/gsm_voice
  method: POST
  url_parameters:
    - name: session_id
@@ -49,7 +49,7 @@ endpoint:
  json_parameters:
    - name: state
      type: string
-      description: State of GSM voice
+      description: State of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'.

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/commands-yml/commands/device/network/send-sms.yml
+++ b/commands-yml/commands/device/network/send-sms.yml
@@ -8,7 +8,7 @@ example_usage:
      await driver.sendSms('555-123-4567', 'Hey lol');
  ruby:
    |
-      @driver.toggle_flight_mode();
+      // TODO
  php:
    |
      // TODO
@@ -36,15 +36,15 @@ driver_support:
 client_support:
  java: false
  python: false
-  ruby: true
-  php: true
-  csharp: true
+  ruby: false
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/send_sms
+  url: /session/:session_id/appium/device/send_sms
  method: POST
  url_parameters:
    - name: session_id
@@ -59,4 +59,4 @@ endpoint:

 # Links to specifications. Should link to at least one specification
 specifications: 
-  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L396
+  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L337
--- a/commands-yml/commands/device/network/toggle-airplane-mode.yml
+++ b/commands-yml/commands/device/network/toggle-airplane-mode.yml
@@ -49,7 +49,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/toggle_airplane_mode
+  url: /session/:session_id/appium/device/toggle_airplane_mode
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/network/toggle-data.yml
+++ b/commands-yml/commands/device/network/toggle-data.yml
@@ -45,7 +45,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/toggle_data
+  url: /session/:session_id/appium/device/toggle_data
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/network/toggle-location-services.yml
+++ b/commands-yml/commands/device/network/toggle-location-services.yml
@@ -53,7 +53,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/toggle_location_services
+  url: /session/:session_id/appium/device/toggle_location_services
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/network/toggle-wifi.yml
+++ b/commands-yml/commands/device/network/toggle-wifi.yml
@@ -45,7 +45,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/toggle_wifi
+  url: /session/:session_id/appium/device/toggle_wifi
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/performance-data/get-performance-data.yml
+++ b/commands-yml/commands/device/performance-data/get-performance-data.yml
@@ -5,7 +5,7 @@ short_description: Returns the information of the system state which is supporte
 example_usage:
  java:
    |
-      List<String> performanceTypes = driver.getSupportedPerformanceDataTypes();
+      List<List<Object>> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5);
  ruby:
    |
      @driver.get_performance_data()
@@ -36,10 +36,10 @@ driver_support:
    windows: false # TODO Confirm this
 client_support:
  java: true
-  python: true
+  python: false
  ruby: true
-  php: true
-  csharp: true
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true
  
@@ -67,4 +67,4 @@ endpoint:

 # Links to specifications. Should link to at least one specification
 specifications:
-  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L322
+  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L325
--- a/commands-yml/commands/device/performance-data/performance-data-types.yml
+++ b/commands-yml/commands/device/performance-data/performance-data-types.yml
@@ -36,10 +36,10 @@ driver_support:
    windows: false # TODO Confirm this
 client_support:
  java: true
-  python: true
+  python: false
  ruby: true
-  php: true
-  csharp: true
+  php: false
+  csharp: false
  javascript_wd: true
  javascript_wdio: true
  
--- a/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml
+++ b/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml
@@ -65,8 +65,11 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/simulator/toggle_touch_id_enrollment
+  url: /session/:session_id/appium/simulator/toggle_touch_id_enrollment
  method: 'POST'
+  url_parameters:
+    - name: session_id
+      description: ID of the session to route the command to
  json_parameters:
    - name: enabled
      type: boolean
@@ -74,4 +77,4 @@ endpoint:

 # Links to specifications. Should link to at least one specification
 specifications: 
-  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L424
+  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L427
--- a/commands-yml/commands/device/simulator/touch-id.yml
+++ b/commands-yml/commands/device/simulator/touch-id.yml
@@ -7,7 +7,7 @@ description:
    must be [enrolled](https://support.apple.com/en-ca/ht201371). 

    When you set `allowTouchIdEnroll` to true, it will set the Simulator to be enrolled by default. 
-    The enrollment state can be [toggled](/docs/en/commands/simulator/toggle-touch-id-enrollment)
+    The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment)

    This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

@@ -73,8 +73,11 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/simulator/touch_id
+  url: /session/:session_id/appium/simulator/touch_id
  method: 'POST'
+  url_parameters:
+    - name: session_id
+      description: ID of the session to route the command to
  json_parameters:
    - name: match
      type: boolean
--- a/commands-yml/commands/device/system/open-notifications.yml
+++ b/commands-yml/commands/device/system/open-notifications.yml
@@ -57,7 +57,7 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/open_notifications
+  url: /session/:session_id/appium/device/open_notifications
  method: POST
  url_parameters:
    - name: session_id
--- a/commands-yml/commands/device/system/system-bars.yml
+++ b/commands-yml/commands/device/system/system-bars.yml
@@ -45,11 +45,14 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/system_bars
-  method: POST
+  url: /session/:session_id/appium/device/system_bars
+  method: GET
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
+  response:
+    - type: array<object>
+      description: Information about visibility and bounds of status and navigation bar

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/commands-yml/commands/device/system/system-time.yml
+++ b/commands-yml/commands/device/system/system-time.yml
@@ -57,11 +57,14 @@ client_support:

 # Information about the HTTP endpoints
 endpoint:
-  url: /session/:session_id/device/system_time
+  url: /session/:session_id/appium/device/system_time
  method: GET
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
+  response:
+    - type: string
+      description: Time on the device

 # Links to specifications. Should link to at least one specification
 specifications: 
--- a/docs/en/commands/device/activity/start-activity.md
+++ b/docs/en/commands/device/activity/start-activity.md
@@ -5,7 +5,7 @@ Get the name of the current Android activity

 ```java
 // Java
-driver.currentActivity(new Activity("com.example", "ActivityName"));
+driver.startActivity(new Activity("com.example", "ActivityName"));

 ```

--- a/docs/en/commands/device/app/background-app.md
+++ b/docs/en/commands/device/app/background-app.md
@@ -88,7 +88,7 @@ await driver.backgroundApp(10);

 |name|type|description|
 |----|----|-----------|
-| seconds | `number` | How long to run app in background. Minimum resolution time is one second. |
+| seconds | `number` | How long to run app in background. |

 ### Response

--- a/docs/en/commands/device/files/pull-file.md
+++ b/docs/en/commands/device/files/pull-file.md
@@ -76,7 +76,7 @@ let fileBase64 = await driver.pullFile('/path/to/device/foo.bar');

 ### Endpoint

-`POST /wd/hub/session/:session_id/device/pull_file`
+`POST /wd/hub/session/:session_id/appium/device/pull_file`

 ### URL Parameters

--- a/docs/en/commands/device/files/pull-folder.md
+++ b/docs/en/commands/device/files/pull-folder.md
@@ -88,11 +88,11 @@ let folderBase64 = await driver.pullFolder('/path/to/device/foo.bar');

 |name|type|description|
 |----|----|-----------|
-| path | `string` | Path on the device to pull file from |
+| path | `string` | Path to an entire folder on the device |

 ### Response

-Contents of file in base64 (`string`)
+A string of Base64 encoded data, representing a zip archive of the contents of the requested folder. (`string`)

 ## See Also

--- a/docs/en/commands/device/files/push-file.md
+++ b/docs/en/commands/device/files/push-file.md
@@ -77,7 +77,7 @@ await driver.pushFileToDevice('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2

 ### Endpoint

-`POST /wd/hub/session/:session_id/device/push_file`
+`POST /wd/hub/session/:session_id/appium/device/push_file`

 ### URL Parameters

--- a/docs/en/commands/device/interactions/is-locked.md
+++ b/docs/en/commands/device/interactions/is-locked.md
@@ -51,8 +51,8 @@ let isLocked = await driver.isLocked();

 |Platform|Driver|Platform Versions|Appium Version|Driver Version|
 |--------|----------------|------|--------------|--------------|
-| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
-|  | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | 8.0 to 9.3 | All | All |
+| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | None | None | None |
+|  | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None |
 | Android | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
 |  | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All |
 | Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None |
--- a/docs/en/commands/device/interactions/lock.md
+++ b/docs/en/commands/device/interactions/lock.md
@@ -86,7 +86,9 @@ await driver.lock();

 ### JSON Parameters

-None
+|name|type|description|
+|----|----|-----------|
+| seconds | `number` | How long to lock the screen (iOS only). |

 ### Response

--- a/docs/en/commands/device/interactions/shake.md
+++ b/docs/en/commands/device/interactions/shake.md
@@ -94,4 +94,4 @@ null

 ## See Also

-* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L292)
+* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L301)
--- a/docs/en/commands/device/interactions/unlock.md
+++ b/docs/en/commands/device/interactions/unlock.md
@@ -55,8 +55,8 @@ await driver.unlock();

 |Platform|Driver|Platform Versions|Appium Version|Driver Version|
 |--------|----------------|------|--------------|--------------|
-| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
-|  | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | 8.0 to 9.3 | All | All |
+| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | None | None | None |
+|  | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None |
 | Android | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
 |  | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All |
 | Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None |
--- a/docs/en/commands/device/keys/hide-keyboard.md
+++ b/docs/en/commands/device/keys/hide-keyboard.md
@@ -29,7 +29,7 @@ await driver.hideDeviceKeyboard();

 ```ruby
 # Ruby
-@driver.find_element(:accessibility_id, 'SomeAccessibilityID')
+@driver.hide_keyboard()

 ```

@@ -76,7 +76,7 @@ await driver.hideDeviceKeyboard();

 ### Endpoint

-`POST /wd/hub/session/:session_id/element`
+`POST /wd/hub/session/:session_id/appium/device/hide_keyboard`

 ### URL Parameters

@@ -88,7 +88,7 @@ await driver.hideDeviceKeyboard();

 |name|type|description|
 |----|----|-----------|
-| strategy | `string` | Hide keyboard strategy (optional) |
+| strategy | `string` | Hide keyboard strategy (optional, UIAutomation only). Available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'. |
 | key | `string` | Key (optional) |
 | keyCode | `string` | Key code (optional) |
 | keyName | `string` | Key name (optional) |
--- a/docs/en/commands/device/keys/is-keyboard-shown.md
+++ b/docs/en/commands/device/keys/is-keyboard-shown.md
@@ -5,7 +5,7 @@ Whether or not the soft keyboard is shown

 ```java
 // Java
-boolean isKeyboardShown = driver.manager().isKeyboardShown();
+boolean isKeyboardShown = driver.isKeyboardShown();

 ```

@@ -65,7 +65,7 @@ boolean isKeyboardShown = driver.manager().isKeyboardShown();

 ### Endpoint

-`POST /wd/hub/session/:session_id/element`
+`GET /wd/hub/session/:session_id/appium/device/is_keyboard_shown`

 ### URL Parameters

@@ -75,16 +75,11 @@ boolean isKeyboardShown = driver.manager().isKeyboardShown();

 ### JSON Parameters

-|name|type|description|
-|----|----|-----------|
-| strategy | `string` | Hide keyboard strategy (optional) |
-| key | `string` | Key (optional) |
-| keyCode | `string` | Key code (optional) |
-| keyName | `string` | Key name (optional) |
+None

 ### Response

-null
+True if the keyboard is shown. (`boolean`)

 ## See Also

--- a/docs/en/commands/device/keys/long-press-keycode.md
+++ b/docs/en/commands/device/keys/long-press-keycode.md
@@ -5,7 +5,7 @@ Press and hold a particular key code on the device

 ```java
 // Java
-driver.longPressKeyCode(10);
+driver.longPressKeyCode(AndroidKeyCode.HOME);

 ```

@@ -86,7 +86,7 @@ driver.longPressKeyCode(10);

 |name|type|description|
 |----|----|-----------|
-| keycode | `number` | \[Key code](http://developer.android.com/reference/android/view/KeyEvent.html) pressed on the device |
+| keycode | `number` | Key code pressed on the device. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html). |
 | metastate | `number` | Metastate for the keypress |

 ### Response
--- a/docs/en/commands/device/keys/press-keycode.md
+++ b/docs/en/commands/device/keys/press-keycode.md
@@ -5,7 +5,7 @@ Press a particular key on the device

 ```java
 // Java
-driver.pressKeyCode(10);
+driver.pressKeyCode(AndroidKeyCode.SPACE, AndroidKeyMetastate.META_SHIFT_ON);

 ```

@@ -86,7 +86,7 @@ driver.pressKeycode(10);

 |name|type|description|
 |----|----|-----------|
-| keycode | `number` | \[Key code](http://developer.android.com/reference/android/view/KeyEvent.html) pressed on the device |
+| keycode | `number` | Key code pressed on the device. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html). |
 | metastate | `number` | Metastate for the keypress |

 ### Response
--- a/docs/en/commands/device/network/gsm-call.md
+++ b/docs/en/commands/device/network/gsm-call.md
@@ -59,15 +59,15 @@ await driver.gsmCall('555-123-4567', 'Phone');
 |[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L3183)  |
-|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| None |  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

 ### Endpoint

-`POST /session/:session_id/device/gsm_call`
+`POST /session/:session_id/appium/device/gsm_call`

 ### URL Parameters

@@ -80,7 +80,7 @@ await driver.gsmCall('555-123-4567', 'Phone');
 |name|type|description|
 |----|----|-----------|
 | phoneNumber | `string` | The phone number to call to |
-| message | `string` | The action |
+| action | `string` | The action - 'call', 'accept', 'cancel', 'hold'. |

 ### Response

--- a/docs/en/commands/device/network/gsm-signal.md
+++ b/docs/en/commands/device/network/gsm-signal.md
@@ -59,15 +59,15 @@ await driver.gsmSignal(3);
 |[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L3221)  |
-|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| None |  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

 ### Endpoint

-`POST /session/:session_id/device/gsm_signal`
+`POST /session/:session_id/appium/device/gsm_signal`

 ### URL Parameters

--- a/docs/en/commands/device/network/gsm-voice.md
+++ b/docs/en/commands/device/network/gsm-voice.md
@@ -59,15 +59,15 @@ await driver.gsmVoice('Voice state');
 |[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L3241)  |
-|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| None |  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

 ### Endpoint

-`POST /session/:session_id/device/gsm_voice`
+`POST /session/:session_id/appium/device/gsm_voice`

 ### URL Parameters

@@ -79,7 +79,7 @@ await driver.gsmVoice('Voice state');

 |name|type|description|
 |----|----|-----------|
-| state | `string` | State of GSM voice |
+| state | `string` | State of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'. |

 ### Response

--- a/docs/en/commands/device/network/send-sms.md
+++ b/docs/en/commands/device/network/send-sms.md
@@ -22,7 +22,7 @@ await driver.sendSms('555-123-4567', 'Hey lol');

 ```ruby
 # Ruby
-@driver.toggle_flight_mode();
+// TODO

 ```

@@ -61,15 +61,15 @@ await driver.sendSms('555-123-4567', 'Hey lol');
 |[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L3183)  |
-|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| None |  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

 ### Endpoint

-`POST /session/:session_id/device/send_sms`
+`POST /session/:session_id/appium/device/send_sms`

 ### URL Parameters

@@ -90,4 +90,4 @@ null

 ## See Also

-* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L396)
+* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L337)
--- a/docs/en/commands/device/network/toggle-airplane-mode.md
+++ b/docs/en/commands/device/network/toggle-airplane-mode.md
@@ -72,7 +72,7 @@ await driver.toggleAirplaneMode();

 ### Endpoint

-`POST /session/:session_id/toggle_airplane_mode`
+`POST /session/:session_id/appium/device/toggle_airplane_mode`

 ### URL Parameters

--- a/docs/en/commands/device/network/toggle-data.md
+++ b/docs/en/commands/device/network/toggle-data.md
@@ -70,7 +70,7 @@ await driver.toggleData();

 ### Endpoint

-`POST /session/:session_id/device/toggle_data`
+`POST /session/:session_id/appium/device/toggle_data`

 ### URL Parameters

--- a/docs/en/commands/device/network/toggle-location-services.md
+++ b/docs/en/commands/device/network/toggle-location-services.md
@@ -74,7 +74,7 @@ await driver.toggleLocationServices();

 ### Endpoint

-`POST /session/:session_id/device/toggle_location_services`
+`POST /session/:session_id/appium/device/toggle_location_services`

 ### URL Parameters

--- a/docs/en/commands/device/network/toggle-wifi.md
+++ b/docs/en/commands/device/network/toggle-wifi.md
@@ -70,7 +70,7 @@ await driver.toggleWiFi();

 ### Endpoint

-`POST /session/:session_id/device/toggle_wifi`
+`POST /session/:session_id/appium/device/toggle_wifi`

 ### URL Parameters

--- a/docs/en/commands/device/performance-data/get-performance-data.md
+++ b/docs/en/commands/device/performance-data/get-performance-data.md
@@ -5,7 +5,7 @@ Returns the information of the system state which is supported to read as like c

 ```java
 // Java
-List<String> performanceTypes = driver.getSupportedPerformanceDataTypes();
+List<List<Object>> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5);

 ```

@@ -58,12 +58,12 @@ List<String> performanceTypes = driver.getSupportedPerformanceDataTypes();
 |Language|Support|Documentation|
 |--------|-------|-------------|
 |[Java](https://github.com/appium/java-client/releases/latest)| All |  [appium.github.io](http://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--)  |
-|[Python](https://github.com/appium/python-client/releases/latest)| All |  |
+|[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  |
 |[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  [github.com](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L59)  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

@@ -91,4 +91,4 @@ The information type of the system state which is supported to read as like cpu,

 ## See Also

-* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L322)
+* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L325)
--- a/docs/en/commands/device/performance-data/performance-data-types.md
+++ b/docs/en/commands/device/performance-data/performance-data-types.md
@@ -58,12 +58,12 @@ List<String> performanceTypes = driver.getSupportedPerformanceDataTypes();
 |Language|Support|Documentation|
 |--------|-------|-------------|
 |[Java](https://github.com/appium/java-client/releases/latest)| All |  [appium.github.io](http://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--)  |
-|[Python](https://github.com/appium/python-client/releases/latest)| All |  |
+|[Python](https://github.com/appium/python-client/releases/latest)| None |  |
 |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All |  |
 |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All |  |
 |[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All |  [www.rubydoc.info](http://www.rubydoc.info/github/appium/ruby_lib/Appium/Android/Device:get_performance_data_types)  |
-|[PHP](https://github.com/appium/php-client/releases/latest)| All |  [github.com](https://github.com/appium/php-client/)  |
-|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |
+|[PHP](https://github.com/appium/php-client/releases/latest)| None |  [github.com](https://github.com/appium/php-client/)  |
+|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None |  [github.com](https://github.com/appium/appium-dotnet-driver/)  |

 ## HTTP API Specifications

--- a/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md
+++ b/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md
@@ -83,11 +83,13 @@ This call will only work if the Appium process or its parent application (e.g.,

 ### Endpoint

-`POST /session/:session_id/simulator/toggle_touch_id_enrollment`
+`POST /session/:session_id/appium/simulator/toggle_touch_id_enrollment`

 ### URL Parameters

-None
+|name|description|
+|----|-----------|
+|session_id|ID of the session to route the command to|

 ### JSON Parameters

@@ -101,4 +103,4 @@ null

 ## See Also

-* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L424)
+* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L427)
--- a/docs/en/commands/device/simulator/touch-id.md
+++ b/docs/en/commands/device/simulator/touch-id.md
@@ -57,7 +57,7 @@ To enable this feature, the `allowTouchIdEnroll` desired capability must be set
 must be [enrolled](https://support.apple.com/en-ca/ht201371). 

 When you set `allowTouchIdEnroll` to true, it will set the Simulator to be enrolled by default. 
-The enrollment state can be [toggled](/docs/en/commands/simulator/toggle-touch-id-enrollment)
+The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment)

 This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

@@ -91,11 +91,13 @@ This call will only work if Appium process or its parent application (e.g. Termi

 ### Endpoint

-`POST /session/:session_id/simulator/touch_id`
+`POST /session/:session_id/appium/simulator/touch_id`

 ### URL Parameters

-None
+|name|description|
+|----|-----------|
+|session_id|ID of the session to route the command to|

 ### JSON Parameters

--- a/docs/en/commands/device/system/open-notifications.md
+++ b/docs/en/commands/device/system/open-notifications.md
@@ -76,7 +76,7 @@ await driver.openNotifications();

 ### Endpoint

-`POST /session/:session_id/device/open_notifications`
+`POST /session/:session_id/appium/device/open_notifications`

 ### URL Parameters

--- a/docs/en/commands/device/system/system-bars.md
+++ b/docs/en/commands/device/system/system-bars.md
@@ -69,7 +69,7 @@ Map<String, String> systemBars = driver.getSystemBars();

 ### Endpoint

-`POST /session/:session_id/device/system_bars`
+`GET /session/:session_id/appium/device/system_bars`

 ### URL Parameters

@@ -83,7 +83,7 @@ None

 ### Response

-null
+Information about visibility and bounds of status and navigation bar (`array<object>`)

 ## See Also

--- a/docs/en/commands/device/system/system-time.md
+++ b/docs/en/commands/device/system/system-time.md
@@ -76,7 +76,7 @@ let time = await driver.getDeviceTime();

 ### Endpoint

-`GET /session/:session_id/device/system_time`
+`GET /session/:session_id/appium/device/system_time`

 ### URL Parameters

@@ -90,7 +90,7 @@ None

 ### Response

-null
+Time on the device (`string`)

 ## See Also

--- a/docs/toc.js
+++ b/docs/toc.js
@@ -76,6 +76,8 @@ module.exports = {
          ["Rotate", "rotate.md"],
        ]],
        ["Keys", ["keys",
+          ["Press keycode", "press-keycode.md"],
+          ["Long press keycode", "long-press-keycode.md"],
          ["Hide Keyboard", "hide-keyboard.md"],
          ["Is Keyboard Shown", "is-keyboard-shown.md"],
        ]],