More documentation of the dummy gatekeeper API

[osm/vim-emu.git] / src / emuvim / api / sonata / __init__.py

diff --git a/src/emuvim/api/sonata/__init__.py b/src/emuvim/api/sonata/__init__.py
index 200337a..14182c5 100644 (file)
--- a/src/emuvim/api/sonata/__init__.py
+++ b/src/emuvim/api/sonata/__init__.py
@@ -11,6 +11,13 @@ import dummygatekeeper as dgk
 
 
 class SonataDummyGatekeeperEndpoint(object):
+    """
+    Creates and starts a REST API based on Flask in an
+    additional thread.
+
+    Can connect this API to data centers defined in an emulator
+    topology.
+    """
 
     def __init__(self, listenip, port):
         self.dcs = {}