REST_API.adoc

REST API for Emender-Waive service

Emender-Waive service is controlled via REST API. Basic supported operations:

Test waives CRUD:

Other test waives-related calls:

Other calls:

• get info about the application

• get banner

REST API calls

Info

/api/v1

Gets information about the app, such as the version currently running.

Method: GET

Content-Type: application/json

Example: curl http://url-to-interface:port/api/v1

Response:

{
    "name" :       "Emender Waive Service",
    "version" :    "0.1.0",
    "api_prefix" : "/api/v1",
    "hostname" :   "hostname"
}

HTTP Status Code: HTTP/1.1 200 OK

Show configuration

/api/v1/configuration

Gets information about the current configuration.

Method: GET

Content-Type: application/json

Example: curl http://url-to-interface:port/api/v1/configuration

Response:

TBD

HTTP Status Code: HTTP/1.1 200 OK

Banner

api/v1/system/banners

Gets the banners that should be displayed in the UI.

Method: GET

Content­Type: application/json

Example: curl http://url-to-interface:port/api/v1/system/banners

Response:

[
    {
        "message": "Alpha version",
        "type":    "warning"
    }
]

HTTP Status Code: HTTP/1.1 200 OK