appium/commands-yml/commands/status.yml

Automation for Apps.

---
name: Status
short_description: Retrieve the server’s current status
description:
  |
    Returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation.

    The readiness state is represented by the ready property of the body, which is false if an attempt to create a session at the current time would fail. However, the value true does not guarantee that a New Session command will succeed.

    Implementations may optionally include additional meta information as part of the body, but the top-level properties ready and message are reserved and must not be overwritten.
example_usage:
  java: // TODO
  python:
    |
      selenium.webdriver.common.utils.is_url_connectable(port)
  javascript_wd:
    |
      await driver.status();
  javascript_wdio:
    |
      driver.status();
  ruby:
    |
      @driver.remote_status
      remote_status
  php:
    |
      // TODO
  csharp:
    |
      // TODO

client_docs:
  # java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/" # TODO
  python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.utils.is_url_connectable"
  javascript_wdio: "http://webdriver.io/api/protocol/status.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L44"
  ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/DriverExtensions/HasRemoteStatus#remote_status-instance_method"
  php: "https://github.com/appium/php-client/" # TODO
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

# Driver support by platform
driver_support:
  ios:
    xcuitest: true
    uiautomation: true
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: true
  windows:
    windows: true
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true

# Information about the HTTP endpoints
endpoint:
  url: /wd/hub/status
  method: GET
  response:
    - name: build.version
      type: string
      description: A generic release label (i.e. "2.0rc3")
    - name: build.revision
      type: string
      description: The revision of the local source control client from which the server was built

# Links to specifications. Should link to at least one specification
specifications: 
  w3c: https://www.w3.org/TR/webdriver/#status
  jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#status