appium/commands-yml/commands/session/logs/get-log.yml

Automation for Apps.

---
name: Get Logs
short_description: Get the log for a given log type. Log buffer is reset after each request
   
example_usage:
  java:
    |
      LogEntries logEntries = driver.manage().logs().get("driver");
  python:
    |
      logs = driver.get_log('driver');
  javascript_wd:
    |
      const logs = await driver.log('driver');

  javascript_wdio:
    |
      let logs = driver.log('driver')
  ruby:
    |
      @driver.get_log('driver')
  php:
    |
      // TODO PHP sample
  csharp:
    |
      // TODO C# sample

client_docs:
  java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/logging/SessionLogs.html#getLogTypes--"
  python: "http://selenium-python.readthedocs.io/api.html?highlight=get_log#selenium.webdriver.remote.webdriver.WebDriver.get_log"
  javascript_wdio: "http://webdriver.io/api/protocol/log.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L455"
  ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Common#get_log-instance_method"
  php: "https://github.com/appium/php-client/" # TODO PHP documentation link
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# Driver support by platform
driver_support:
  ios:
    xcuitest: true
    uiautomation: true
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: true # TODO Confirm this that mouse movements
  windows:
    windows: true # TODO Confirm this
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: /session/:session_id/log
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: type
      type: string
      description: The log type
  response:
    - type: array<object>
      description: The list of log entries

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog