From e843518e9927044f28d997dd00feb7261087b4ff Mon Sep 17 00:00:00 2001
From: Vinicius Arcanjo <vindasil@fiu.edu>
Date: Fri, 7 Jun 2024 14:22:15 -0300
Subject: [PATCH] docs: updated CHANGELOG.rst and README.rst

---
 CHANGELOG.rst |  1 +
 README.rst    | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 7233a033..8df63b55 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -11,6 +11,7 @@ Added
 - EVC list now utilizes ``localStorage`` to store ``search_cols`` and make them persistent throughout EVC list usage.
 - Added ``kytos/mef_eline.uni_active_updated`` event
 - Included "id" on EVC mapped content to normalize it with the other models
+- Introduced ``failover_old_path``, ``failover_deployed``, and ``failover_link_down`` events, which will be primarily consumed by ``telemetry_int`` NApp
 
 Changed
 =======
diff --git a/README.rst b/README.rst
index 1836aa21..9dfd8035 100644
--- a/README.rst
+++ b/README.rst
@@ -109,6 +109,73 @@ Event published when an EVC active state changes due to a UNI going up or down
    "uni_z": evc.uni_z.as_dict()}
   }
 
+kytos/mef_eline.failover_deployed
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Event published when an EVC failover_path gets deployed. ``flows`` are the new deployed flows, and ``removed_flows`` are the removed ones.
+
+.. code-block:: python3
+   
+  {
+   evc.id: {
+     "id", evc.id,
+     "evc_id": evc.id,
+     "name": evc.name,
+     "metadata": evc.metadata,
+     "active": evc._active,
+     "enabled": evc._enabled,
+     "uni_a": evc.uni_a.as_dict(),
+     "uni_z": evc.uni_z.as_dict(),
+     "flows": [],
+     "removed_flows": [],
+     "error_reason": string,
+     "current_path": evc.current_path.as_dict(),
+   }
+  }
+
+kytos/mef_eline.failover_link_down
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Event published when an EVC failover_path switches over. ``flows`` are the new deployed flows.
+
+.. code-block:: python3
+   
+  {
+   evc.id: {
+     "id", evc.id,
+     "evc_id": evc.id,
+     "name": evc.name,
+     "metadata": evc.metadata,
+     "active": evc._active,
+     "enabled": evc._enabled,
+     "uni_a": evc.uni_a.as_dict(),
+     "uni_z": evc.uni_z.as_dict(),
+     "flows": [],
+   }
+  }
+
+kytos/mef_eline.failover_old_path
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Event published when an EVC failover related old path gets removed (cleaned up). ``removed_flows`` are the removed flows.
+
+.. code-block:: python3
+   
+  {
+   evc.id: {
+     "id", evc.id,
+     "evc_id": evc.id,
+     "name": evc.name,
+     "metadata": evc.metadata,
+     "active": evc._active,
+     "enabled": evc._enabled,
+     "uni_a": evc.uni_a.as_dict(),
+     "uni_z": evc.uni_z.as_dict(),
+     "removed_flows": [],
+     "current_path": evc.current_path.as_dict(),
+   }
+  }
+
 
 .. TAGs