Contents

How do i use the api?
==============


Well, we want to do things as simple as possible, so we are using only GET requests. Everyone has a browser, so everyone has the possiblility to use Kaya.

Returns the list of suites

    kaya/api/suites

Returns the list of suites that are running

    kaya/api/suites/running

Returns the status of the given suite id

    kaya/api/suites/<suite_id>/status

Returns the suite structure for the given suite id

    kaya/api/suites/<suite_id>

Returns all existing results

    kaya/api/results

Returns the result for a given result id

    kaya/api/results/<result_id>

Starts an execution

  Perform get to:

    kaya/api/suites/<suite_me>/run

    # pass custom parameters as query string like vkaya/api/suites/:suite/run?environment=RC&foo=bar

    # and if you want identify the execution, you can pass execution_name=your_execution_identification' as query string too.

  If execution starts succesfully, it will return a result id


Returns the execution data for a given result id

    kaya/api/results/<result_id>/data

Version data entries

14 entries across 14 versions & 1 rubygems

Version	Path
kaya-0.0.14	documentation/api.md
kaya-0.0.13	documentation/api.md
kaya-0.0.12	documentation/api.md
kaya-0.0.11	documentation/api.md
kaya-0.0.10	documentation/api.md
kaya-0.0.9	documentation/api.md
kaya-0.0.8	documentation/api.md
kaya-0.0.7	documentation/api.md
kaya-0.0.6	documentation/api.md
kaya-0.0.5	documentation/api.md
kaya-0.0.4	documentation/api.md
kaya-0.0.3	documentation/api.md
kaya-0.0.2	documentation/api.md
kaya-0.0.1	documentation/api.md