Documented Actions API

Change-Id: Ia7ae9ae8b26556102008a0c1b80542a2277e9c1e

doc/source/conf.py

@@ -25,7 +25,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinxcontrib.autohttp.flask',
     'sphinxcontrib.pecanwsme.rest',
-    'oslosphinx',
+    #  'oslosphinx',
     'wsmeext.sphinxext',
 ]
 
@@ -43,7 +43,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'surveil'
-copyright = u'2014, Surveil Contributors'
+copyright = u'2014-2015, Surveil Contributors'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -60,8 +60,9 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 # html_theme_path = ["."]
-# html_theme = '_theme'
-html_static_path = ['_static']
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project

doc/source/index.rst

@@ -8,7 +8,6 @@ Table of Contents:
    :maxdepth: 2
 
    readme
-   getting_started
    webapi/index
 
 Indices and tables

doc/source/webapi/v2/actions.rst

@@ -0,0 +1,26 @@
+.. docbookrestapi
+
+=======
+Actions
+=======
+
+acknowledge
+===========
+
+.. rest-controller:: surveil.api.controllers.v2.actions.acknowledge:AcknowledgeController
+   :webprefix: /v2/actions/acknowledge
+
+downtime
+========
+
+.. rest-controller:: surveil.api.controllers.v2.actions.downtime:DowntimeController
+   :webprefix: /v2/actions/downtime
+
+types documentation
+===================
+
+.. autotype:: surveil.api.datamodel.actions.acknowledgement.Acknowledgement
+   :members:
+
+.. autotype:: surveil.api.datamodel.actions.downtime.Downtime
+   :members:

doc/source/webapi/v2/config.rst

@@ -28,11 +28,6 @@ Hosts
 .. 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
 ========
@@ -40,7 +35,7 @@ Services
 .. rest-controller:: surveil.api.controllers.v2.config.services:ServicesController
    :webprefix: /v2/config/services
 
-.. autotype:: surveil.api.controllers.v2.datamodel.service.Service
+.. autotype:: surveil.api.datamodel.config.service.Service
    :members:
 
 
@@ -53,6 +48,16 @@ Commands
 .. rest-controller:: surveil.api.controllers.v2.config.commands:CommandController
    :webprefix: /v2/config/commands
 
-.. autotype:: surveil.api.controllers.v2.datamodel.command.Command
+
+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:
 

doc/source/webapi/v2/index.rst

@@ -7,3 +7,4 @@ V2 Web API
 
    config
    status
+   actions

doc/source/webapi/v2/logs.rst

@@ -1,36 +0,0 @@
-.. docbookrestapi
-
-====
-Logs
-====
-
-.. rest-controller:: surveil.api.controllers.v2.logs:LogsController
-   :webprefix: /v2/logs
-
-
-Acknowledgements
-================
-
-.. rest-controller:: surveil.api.controllers.v2.logs.acknowledgements:AcknowledgementsController
-   :webprefix: /v2/logs/acknowledgements
-
-
-Comments
-========
-
-.. rest-controller:: surveil.api.controllers.v2.logs.comments:CommentsController
-   :webprefix: /v2/logs/comments
-
-
-Downtimes
-=========
-
-.. rest-controller:: surveil.api.controllers.v2.logs.downtimes:DowntimesController
-   :webprefix: /v2/logs/downtimes
-
-
-Notifications
-=============
-
-.. rest-controller:: surveil.api.controllers.v2.logs.notifications:NotificationsController
-   :webprefix: /v2/logs/notifications

doc/source/webapi/v2/status.rst

@@ -54,8 +54,8 @@ Metrics
 .. rest-controller:: surveil.api.controllers.v2.status.metrics:MetricController
    :webprefix: /v2/status/metrics/
 
-Types
-=====
+types documentation
+===================
 
 .. autotype:: surveil.api.datamodel.status.live_service.LiveService
    :members:

surveil/api/datamodel/actions/downtime.py

@@ -25,7 +25,7 @@ class Downtime(types.Base):
     service_description = wsme.wsattr(wtypes.text, mandatory=False)
     """Ther service description"""
 
-    time_stamp = wsme.wsattr(wtypes.text, mandatory=False)
+    time_stamp = wsme.wsattr(int, mandatory=False)
     """Time stamp for the downtime"""
 
     start_time = wsme.wsattr(int, mandatory=False)

test-requirements.txt

@@ -7,3 +7,4 @@ oslosphinx>=2.5.0
 testrepository>=0.0.18
 mongomock
 httpretty
+sphinx_rtd_theme