appium/commands-yml/commands/example.yml

Automation for Apps.

---
name: 'Template'
short_description: Brief description
description:
  >
    An indepth description
    of what this command does
example_usage:
  java:
    |
      MobileElement el = driver.findElementByAccessibilityId("SomeId");
      el.click();
  python:
    |
      el = self.driver.find_element_by_accessibility_id('SomeId')
      el.click();
  javascript_wd:
    |
      await driver.status();
  javascript_wdio:
    |
      await driver.status();
  ruby:
    |
      # Ruby Code here
  php:
    |
      // PHP Code here
  csharp:
    |
      // CSharp Code here

client_docs:
  java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#click--"
  python: "https://github.com/appium/python-client"
  javascript_wdio: "http://webdriver.io/index.html"
  javascript_wd: "https://github.com/admc/wd/releases"
  ruby: "https://github.com/appium/ruby_lib/releases/latest"
  php: "https://github.com/appium/php-client/releases/latest-"
  csharp: "https://github.com/appium/appium" # TODO

# Driver support by platform
driver_support:
  ios:
    xcuitest:
      platform_min: '1.2'
      platform_max: '9.3'
      appium_min: '1.7'
      appium_max: '1.9'
      driver_min: '1.1'
      driver_max: '9.9'
    uiautomation:
      platform_min: '1.0'
  android:
    uiautomator2:
      platform_min: '8.0'
    uiautomator: true
  mac:
    mac:
      platform_min: '?' # TODO
client_support:
  java:
    min: 1.2
    max: 2.1
  python:
    min: 2
  ruby: true # If true, means it supports all
  php: false # If false(y), means it is not supported
  

# Information about the HTTP endpoints
endpoint:
  url: /wd/hub/session/:session_id/element/:element_id/click
  method: 'POST'
  url_parameters:
    - name: session_id
      description: ID of the session
    - name: element_id
      description: ID of the element to blah blah blah
  json_parameters:
    - name: item
      type: Object
      description: Description of Item
    - name: item.1 # Use dot notation for nested items
      type: String # Type is optional
      description: Item One description
  response:
    - name: build.version # Use dot notation for nested JSON parameters
      type: string # JS type
      description: A generic release label (i.e. "2.0rc3")

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

# Other relevant links
links:
  - name: Google
    url: http://www.google.com