surveil/doc/source/webapi/v2/config.rst
aviau d0530b7d59 Documented Actions API
Change-Id: Ia7ae9ae8b26556102008a0c1b80542a2277e9c1e
2015-04-29 09:56:12 -04:00

64 lines
1.7 KiB
ReStructuredText

.. docbookrestapi
======
Config
======
.. rest-controller:: surveil.api.controllers.v2.config:ConfigController
:webprefix: /v2/config
Hosts
=====
.. rest-controller:: surveil.api.controllers.v2.config.hosts:HostsController
:webprefix: /v2/config/hosts
.. rest-controller:: surveil.api.controllers.v2.config.hosts:HostController
:webprefix: /v2/config/hosts
.. rest-controller:: surveil.api.controllers.v2.config.hosts:HostServicesSubController
:webprefix: /v2/config/hosts/(host_name)/services
.. rest-controller:: surveil.api.controllers.v2.config.hosts:HostServiceSubController
:webprefix: /v2/config/hosts/(host_name)/services/(service_name)
.. rest-controller:: surveil.api.controllers.v2.config.hosts:HostCheckResultsSubController
:webprefix: /v2/config/hosts/(host_name)/results
.. rest-controller:: surveil.api.controllers.v2.config.hosts:ServiceCheckResultsSubController
:webprefix: /v2/config/hosts/(host_name)/services/(service_description)/results
Services
========
.. rest-controller:: surveil.api.controllers.v2.config.services:ServicesController
:webprefix: /v2/config/services
.. autotype:: surveil.api.datamodel.config.service.Service
:members:
Commands
========
.. rest-controller:: surveil.api.controllers.v2.config.commands:CommandsController
:webprefix: /v2/config/commands
.. rest-controller:: surveil.api.controllers.v2.config.commands:CommandController
:webprefix: /v2/config/commands
types documentation
===================
.. autotype:: surveil.api.datamodel.config.command.Command
:members:
.. autotype:: surveil.api.datamodel.config.host.Host
:members:
.. autotype:: surveil.api.datamodel.checkresult.CheckResult
:members: