Skip to content

Latest commit

 

History

History
76 lines (64 loc) · 7.22 KB

README.md

File metadata and controls

76 lines (64 loc) · 7.22 KB
Raw

REST API - WAVE Test Runner

The REST API allows the WAVE server to be integrated into other systems. Every call must be preceded with a namespace or web root, which is omitted in this documentation. The default web root is /_wave, which can be changed in the config.json using the keyword web_root.

Additional REST API Guides can help to understand how to use these endpoints in context.

Sessions API

Name Description
create Creates a new test session.
read session Reads a sessions configuration.
read sessions Reads all session tokens, expandable with configs and statuses
read public Reads all public sessions tokens.
update Updates a session configuration.
delete Deletes a test session.
status Reads the status and progress of a session.
start Starts a test session.
stop Stops a test session.
pause Pauses a test session.
find Finds a session token by providing a token fragment.
labels Attach labels to sessions for organization purposes.
listen events Register for sessions specific events.
push events Push session specific events.

Tests API

Name Description
read all Reads all tests available.
read session Reads all tests that are part of a session.
read next Reads the next test to run in a session.
read last completed Reads the last completed tests of a session.
read malfunctioning Reads the list of malfunctioning tests of a session.
update malfunctioning Updates the list of malfunctioning tests of a session.
read available apis Reads all available APIs names and paths.

Results API

Name Description
create Create a new test result for a test in a session.
read Read all test results of a session.
read compact Read the number of passed, failed, timed out and not run tests of a session.
import session Import session results.
import api results Import results of a specific API into existing session.
download Download all session results to import into other WMATS instance.
download api Download all results of an API.
download all apis Download all results of all APIs.
view report View the WPT report of an API of a session.
view multi report View the WPT report of an API of multiple sessions.
download overview Download an overview of results of all APIs of a session.
view report Read an url to a hosted version of a WPT report for an API of a session.
view multi report Read an url to a hosted version of a WPT report for an API of multiple session.

Devices API

Name Description
create Registers a new device.
read device Read information of a specific device.
read devices Read a list of all available devices.
register event listener Register for a device specific event.
send event Sends a device specific event.
register global event listener Register for a global device event.
send global event Sends a global device event.

General API

Name Description
status Returns information on how the server is configured.