RIC-642 related changes: REST subscription, rnib enhancements, symptomdata, rest...

[ric-plt/xapp-frame-py.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 7147f02..0f2bbdf 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -12,6 +12,17 @@ Xapp writers should use the public classes and methods from the Xapp Python
 framework package as documented below.
 
 
+Class _BaseXapp
+---------------
+
+Although this base class should not be used directly, it is inherited by
+the public classes shown below and all of this class's public methods are
+available for use by application writers.
+
+.. autoclass:: ricxappframe.xapp_frame._BaseXapp
+    :members:
+
+
 Class RMRXapp
 -------------
 
@@ -38,3 +49,27 @@ Application writers may instantiate this class directly to communicate with the
 
 .. autoclass:: ricxappframe.xapp_sdl.SDLWrapper
     :members:
+
+Class Symptomdata
+-----------------
+
+Application writers may instantiate this class directly to communicate with the symptomdata service.
+
+.. autoclass:: ricxappframe.xapp_symptomdata.Symptomdata
+    :members:
+
+Class NewSubscriber
+-------------------
+
+Application writers may instantiate this class directly to communicate REST based subscriptions.
+
+.. autoclass:: ricxappframe.xapp_subscribe.NewSubscriber
+    :members:
+
+Class RestHandler
+-----------------
+
+Application writers may instantiate this class directly to have the xapp REST server service.
+
+.. autoclass:: ricxappframe.xapp_rest.RestHandler
+    :members: