From e48c0bd1655daca76e8e39524bc937c2cb7778fd Mon Sep 17 00:00:00 2001 From: Sebastien Coavoux Date: Tue, 24 Mar 2015 11:16:18 -0400 Subject: [PATCH] Enh: Doc - Add v2 doc from v1 Change-Id: Ib023531dd4687a8e7d7d2fbc282410e880c2ac46 --- doc/source/webapi/index.rst | 1 + doc/source/webapi/v2/config.rst | 58 +++++++++++++++++++++++++++++++++ doc/source/webapi/v2/index.rst | 9 +++++ doc/source/webapi/v2/status.rst | 18 ++++++++++ 4 files changed, 86 insertions(+) create mode 100644 doc/source/webapi/v2/config.rst create mode 100644 doc/source/webapi/v2/index.rst create mode 100644 doc/source/webapi/v2/status.rst diff --git a/doc/source/webapi/index.rst b/doc/source/webapi/index.rst index 5cd2b3e..fad426a 100644 --- a/doc/source/webapi/index.rst +++ b/doc/source/webapi/index.rst @@ -6,3 +6,4 @@ :maxdepth: 2 v1 + v2/index diff --git a/doc/source/webapi/v2/config.rst b/doc/source/webapi/v2/config.rst new file mode 100644 index 0000000..a8be265 --- /dev/null +++ b/doc/source/webapi/v2/config.rst @@ -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: + diff --git a/doc/source/webapi/v2/index.rst b/doc/source/webapi/v2/index.rst new file mode 100644 index 0000000..e1501b0 --- /dev/null +++ b/doc/source/webapi/v2/index.rst @@ -0,0 +1,9 @@ +========== +V2 Web API +========== + +.. toctree:: + :maxdepth: 2 + + config + status diff --git a/doc/source/webapi/v2/status.rst b/doc/source/webapi/v2/status.rst new file mode 100644 index 0000000..20eab7d --- /dev/null +++ b/doc/source/webapi/v2/status.rst @@ -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 + + +