Enh: Doc - Add v2 doc from v1
Change-Id: Ib023531dd4687a8e7d7d2fbc282410e880c2ac46
This commit is contained in:
parent
fce007cdd9
commit
e48c0bd165
doc/source/webapi
@ -6,3 +6,4 @@
|
||||
:maxdepth: 2
|
||||
|
||||
v1
|
||||
v2/index
|
||||
|
58
doc/source/webapi/v2/config.rst
Normal file
58
doc/source/webapi/v2/config.rst
Normal file
@ -0,0 +1,58 @@
|
||||
.. 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
|
||||
|
||||
.. autotype:: surveil.api.controllers.v2.datamodel.checkresult.CheckResult
|
||||
:members:
|
||||
|
||||
.. autotype:: surveil.api.controllers.v2.datamodel.host.Host
|
||||
:members:
|
||||
|
||||
Services
|
||||
========
|
||||
|
||||
.. rest-controller:: surveil.api.controllers.v2.config.services:ServicesController
|
||||
:webprefix: /v2/config/services
|
||||
|
||||
.. autotype:: surveil.api.controllers.v2.datamodel.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
|
||||
|
||||
.. autotype:: surveil.api.controllers.v2.datamodel.command.Command
|
||||
:members:
|
||||
|
9
doc/source/webapi/v2/index.rst
Normal file
9
doc/source/webapi/v2/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
==========
|
||||
V2 Web API
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
config
|
||||
status
|
18
doc/source/webapi/v2/status.rst
Normal file
18
doc/source/webapi/v2/status.rst
Normal file
@ -0,0 +1,18 @@
|
||||
.. docbookrestapi
|
||||
|
||||
======
|
||||
Status
|
||||
======
|
||||
|
||||
.. rest-controller:: surveil.api.controllers.v2.status:StatusController
|
||||
:webprefix: /v2/status
|
||||
|
||||
|
||||
Hosts
|
||||
=====
|
||||
|
||||
.. rest-controller:: surveil.api.controllers.v2.status.hosts:HostsController
|
||||
:webprefix: /v2/status/hosts
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user