22.10.1 released

nokia · Nov 1, 2022 · 17a7bdd · 17a7bdd
1 parent 051b113
commit 17a7bdd
Show file tree

Hide file tree

Showing 37 changed files with 2,900 additions and 449 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-Sphinx~=4.0.2
+Sphinx~=5.1.1
 sphinx-rtd-theme~=0.5.2
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,8 +10,8 @@
 author = 'Nokia'
 
 # The full version, including alpha/beta/rc tags
-version = '22.7.1'
-release = '22.7.1'
+version = '22.10.1'
+release = '22.10.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/ehs.rst b/docs/source/ehs.rst
@@ -13,7 +13,7 @@ the event handling system (EHS).
 .. Reviewed by PLM 20220117
 .. Reviewed by TechComms 20220124
 
-.. py:function:: get_event
+.. py:function:: pysros.ehs.get_event
 
    The EHS event that triggered the execution of the Python application.
 
@@ -23,11 +23,20 @@ the event handling system (EHS).
    .. Reviewed by PLM 20220118
    .. Reviewed by TechComms 20220124
 
-.. class:: Event
+.. class:: pysros.ehs.Event
 
-   The EHS event Class for the event that triggered the execution of the
+   The EHS :py:class:`pysros.ehs.Event` Class for the event that triggered the execution of the
    Python application.
 
+   .. py:attribute:: name
+
+      The name of the event.
+
+      :type: str
+
+      .. Reviewed by PLM 20220930
+      .. Reviewed by TechComms 20221005
+
    .. py:attribute:: appid
 
       The name of the application that generated the event.
@@ -55,6 +64,16 @@ the event handling system (EHS).
       .. Reviewed by PLM 20220118
       .. Reviewed by TechComms 20220124
 
+   .. py:attribute:: sequence
+
+      The sequence number of the event in the syslog collector.
+
+      :type: int
+      :raises ValueError: for negative values.
+
+      .. Reviewed by PLM 20220930
+      .. Reviewed by TechComms 20221005
+
    .. py:attribute:: subject
 
       The subject or affected object of the event.
@@ -64,9 +83,19 @@ the event handling system (EHS).
       .. Reviewed by PLM 20220118
       .. Reviewed by TechComms 20220124
 
+   .. py:attribute:: router_name
+
+      The name of the SR OS router-instance (For example, ``Base``) in which this
+      event was triggered.
+
+      :type: str
+
+      .. Reviewed by PLM 20220930
+      .. Reviewed by TechComms 20221005
+
    .. py:attribute:: gentime
 
-      The formatted time, in ISO 8601 format, that the event was generated.
+      The time, in ISO 8601 format, that the event was generated.
 
       :type: str
 
@@ -82,15 +111,22 @@ the event handling system (EHS).
       .. Reviewed by PLM 20220118
       .. Reviewed by TechComms 20220124
 
-   .. function:: eventparameters
+   .. py:attribute:: text
+
+      The event specific body, formatted as a string.  By default, this
+      is generated from the :py:attr:`eventparameters`.
+
+      :type: str
+
+   .. py:attribute:: eventparameters
 
       The additional parameters specific to the event that caused the
       Python application to execute.
 
       :type: :py:class:`pysros.ehs.EventParams`
 
-      .. Reviewed by PLM 20220118
-      .. Reviewed by TechComms 20220124
+      .. Reviewed by PLM 20220930
+      .. Reviewed by TechComms 20221005
 
    .. py:method:: format_msg
 
@@ -121,11 +157,11 @@ the event handling system (EHS).
       .. Reviewed by PLM 20220118
       .. Reviewed by TechComms 20220124
 
-      .. describe:: params[key]
+   .. describe:: params[key]
 
       Return the value of the parameter *key*. If the parameter does not exist,
       a :exc:`KeyError` is raised.
 
-      .. Reviewed by PLM 20220118
-      .. Reviewed by TechComms 20220124
+      .. Reviewed by PLM 20220930
+      .. Reviewed by TechComms 20221005