From 6eb76e98b52cfbfbbbd4a05ebc10d91ee5c94dc8 Mon Sep 17 00:00:00 2001
From: Tim Hogarty <thogarty@equinix.com>
Date: Wed, 27 Nov 2024 17:19:10 -0800
Subject: [PATCH] Cleanup raw README.md file with newlines for visibility

---
 README.md                                | 115 ++++++++++++++++++++++-
 scripts/generate_readme_event_catalog.py |   4 +-
 2 files changed, 114 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 69e3c99..8ea620f 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,44 @@ The following data payloads are the supported events and formats for Equinix Int
 <details>
 <summary>Released</summary>
 
-`equinix.fabric.connection.attribute.changed`<br>`equinix.fabric.connection.bgpipv4_session_status.connect`<br>`equinix.fabric.connection.bgpipv4_session_status.established`<br>`equinix.fabric.connection.bgpipv4_session_status.idle`<br>`equinix.fabric.connection.bgpipv4_session_status.open_confirm`<br>`equinix.fabric.connection.bgpipv4_session_status.open_confirm`<br>`equinix.fabric.connection.bgpipv4_session_status.open_sent`<br>`equinix.fabric.connection.bgpipv4_session_status.open_sent`<br>`equinix.fabric.connection.bgpipv6_session_status.connect`<br>`equinix.fabric.connection.bgpipv6_session_status.established`<br>`equinix.fabric.connection.bgpipv6_session_status.idle`<br>`equinix.fabric.connection.state.deprovisioned`<br>`equinix.fabric.connection.state.deprovisioning`<br>`equinix.fabric.connection.state.pending`<br>`equinix.fabric.connection.state.provisioned`<br>`equinix.fabric.connection.state.provisioning`<br>`equinix.fabric.connection.status.down`<br>`equinix.fabric.connection.status.up`<br>`equinix.fabric.network.state.deprovisioned`<br>`equinix.fabric.network.state.deprovisioning`<br>`equinix.fabric.network.state.provisioned`<br>`equinix.fabric.network.state.provisioning`<br>`equinix.fabric.port.state.deprovisioned`<br>`equinix.fabric.port.state.failed`<br>`equinix.fabric.port.state.provisioned`<br>`equinix.fabric.port.status.down`<br>`equinix.fabric.port.status.up`<br>`equinix.fabric.router.state.deprovisioned`<br>`equinix.fabric.router.state.deprovisioning`<br>`equinix.fabric.router.state.failed`<br>`equinix.fabric.router.state.not_deprovisioned`<br>`equinix.fabric.router.state.not_provisioned`<br>`equinix.fabric.router.state.provisioned`<br>`equinix.fabric.router.state.provisioning`<br>`equinix.fabric.router.state.reprovisioning`<br>`equinix.fabric.service_token.attribute.changed`<br>`equinix.fabric.service_token.state.deleted`<br>`equinix.fabric.service_token.state.inactive`
+`equinix.fabric.connection.attribute.changed`<br>
+`equinix.fabric.connection.bgpipv4_session_status.connect`<br>
+`equinix.fabric.connection.bgpipv4_session_status.established`<br>
+`equinix.fabric.connection.bgpipv4_session_status.idle`<br>
+`equinix.fabric.connection.bgpipv4_session_status.open_confirm`<br>
+`equinix.fabric.connection.bgpipv4_session_status.open_confirm`<br>
+`equinix.fabric.connection.bgpipv4_session_status.open_sent`<br>
+`equinix.fabric.connection.bgpipv4_session_status.open_sent`<br>
+`equinix.fabric.connection.bgpipv6_session_status.connect`<br>
+`equinix.fabric.connection.bgpipv6_session_status.established`<br>
+`equinix.fabric.connection.bgpipv6_session_status.idle`<br>
+`equinix.fabric.connection.state.deprovisioned`<br>
+`equinix.fabric.connection.state.deprovisioning`<br>
+`equinix.fabric.connection.state.pending`<br>
+`equinix.fabric.connection.state.provisioned`<br>
+`equinix.fabric.connection.state.provisioning`<br>
+`equinix.fabric.connection.status.down`<br>
+`equinix.fabric.connection.status.up`<br>
+`equinix.fabric.network.state.deprovisioned`<br>
+`equinix.fabric.network.state.deprovisioning`<br>
+`equinix.fabric.network.state.provisioned`<br>
+`equinix.fabric.network.state.provisioning`<br>
+`equinix.fabric.port.state.deprovisioned`<br>
+`equinix.fabric.port.state.failed`<br>
+`equinix.fabric.port.state.provisioned`<br>
+`equinix.fabric.port.status.down`<br>
+`equinix.fabric.port.status.up`<br>
+`equinix.fabric.router.state.deprovisioned`<br>
+`equinix.fabric.router.state.deprovisioning`<br>
+`equinix.fabric.router.state.failed`<br>
+`equinix.fabric.router.state.not_deprovisioned`<br>
+`equinix.fabric.router.state.not_provisioned`<br>
+`equinix.fabric.router.state.provisioned`<br>
+`equinix.fabric.router.state.provisioning`<br>
+`equinix.fabric.router.state.reprovisioning`<br>
+`equinix.fabric.service_token.attribute.changed`<br>
+`equinix.fabric.service_token.state.deleted`<br>
+`equinix.fabric.service_token.state.inactive`
 
 </details>
 
@@ -55,7 +92,10 @@ The following data payloads are the supported events and formats for Equinix Int
 <details>
 <summary>Released</summary>
 
-`equinix.fabric.connection.ipv4_installed_routes.utilization`<br>`equinix.fabric.connection.ipv6_installed_routes.utilization`<br>`equinix.fabric.router.ipv4_installed_routes.utilization`<br>`equinix.fabric.router.ipv6_installed_routes.utilization`
+`equinix.fabric.connection.ipv4_installed_routes.utilization`<br>
+`equinix.fabric.connection.ipv6_installed_routes.utilization`<br>
+`equinix.fabric.router.ipv4_installed_routes.utilization`<br>
+`equinix.fabric.router.ipv6_installed_routes.utilization`
 
 </details>
 
@@ -81,7 +121,76 @@ The following data payloads are the supported events and formats for Equinix Int
 <details>
 <summary>Released</summary>
 
-`equinix.fabric.connection.bandwidth_rx.usage`<br>`equinix.fabric.connection.bandwidth_tx.usage`<br>`equinix.fabric.metro.am_{:metroCode}.latency`<br>`equinix.fabric.metro.at_{:metroCode}.latency`<br>`equinix.fabric.metro.ba_{:metroCode}.latency`<br>`equinix.fabric.metro.bg_{:metroCode}.latency`<br>`equinix.fabric.metro.bl_{:metroCode}.latency`<br>`equinix.fabric.metro.bo_{:metroCode}.latency`<br>`equinix.fabric.metro.bx_{:metroCode}.latency`<br>`equinix.fabric.metro.ca_{:metroCode}.latency`<br>`equinix.fabric.metro.ch_{:metroCode}.latency`<br>`equinix.fabric.metro.cl_{:metroCode}.latency`<br>`equinix.fabric.metro.cu_{:metroCode}.latency`<br>`equinix.fabric.metro.da_{:metroCode}.latency`<br>`equinix.fabric.metro.db_{:metroCode}.latency`<br>`equinix.fabric.metro.dc_{:metroCode}.latency`<br>`equinix.fabric.metro.de_{:metroCode}.latency`<br>`equinix.fabric.metro.dx_{:metroCode}.latency`<br>`equinix.fabric.metro.fr_{:metroCode}.latency`<br>`equinix.fabric.metro.gv_{:metroCode}.latency`<br>`equinix.fabric.metro.he_{:metroCode}.latency`<br>`equinix.fabric.metro.hh_{:metroCode}.latency`<br>`equinix.fabric.metro.hk_{:metroCode}.latency`<br>`equinix.fabric.metro.ho_{:metroCode}.latency`<br>`equinix.fabric.metro.il_{:metroCode}.latency`<br>`equinix.fabric.metro.jh_{:metroCode}.latency`<br>`equinix.fabric.metro.ka_{:metroCode}.latency`<br>`equinix.fabric.metro.kl_{:metroCode}.latency`<br>`equinix.fabric.metro.la_{:metroCode}.latency`<br>`equinix.fabric.metro.ld_{:metroCode}.latency`<br>`equinix.fabric.metro.lm_{:metroCode}.latency`<br>`equinix.fabric.metro.ls_{:metroCode}.latency`<br>`equinix.fabric.metro.ma_{:metroCode}.latency`<br>`equinix.fabric.metro.mb_{:metroCode}.latency`<br>`equinix.fabric.metro.md_{:metroCode}.latency`<br>`equinix.fabric.metro.me_{:metroCode}.latency`<br>`equinix.fabric.metro.mi_{:metroCode}.latency`<br>`equinix.fabric.metro.ml_{:metroCode}.latency`<br>`equinix.fabric.metro.mo_{:metroCode}.latency`<br>`equinix.fabric.metro.mt_{:metroCode}.latency`<br>`equinix.fabric.metro.mu_{:metroCode}.latency`<br>`equinix.fabric.metro.mx_{:metroCode}.latency`<br>`equinix.fabric.metro.ny_{:metroCode}.latency`<br>`equinix.fabric.metro.os_{:metroCode}.latency`<br>`equinix.fabric.metro.ot_{:metroCode}.latency`<br>`equinix.fabric.metro.pa_{:metroCode}.latency`<br>`equinix.fabric.metro.pe_{:metroCode}.latency`<br>`equinix.fabric.metro.ph_{:metroCode}.latency`<br>`equinix.fabric.metro.rj_{:metroCode}.latency`<br>`equinix.fabric.metro.se_{:metroCode}.latency`<br>`equinix.fabric.metro.sg_{:metroCode}.latency`<br>`equinix.fabric.metro.sk_{:metroCode}.latency`<br>`equinix.fabric.metro.sl_{:metroCode}.latency`<br>`equinix.fabric.metro.so_{:metroCode}.latency`<br>`equinix.fabric.metro.sp_{:metroCode}.latency`<br>`equinix.fabric.metro.st_{:metroCode}.latency`<br>`equinix.fabric.metro.sv_{:metroCode}.latency`<br>`equinix.fabric.metro.sy_{:metroCode}.latency`<br>`equinix.fabric.metro.tr_{:metroCode}.latency`<br>`equinix.fabric.metro.ty_{:metroCode}.latency`<br>`equinix.fabric.metro.va_{:metroCode}.latency`<br>`equinix.fabric.metro.wa_{:metroCode}.latency`<br>`equinix.fabric.metro.wi_{:metroCode}.latency`<br>`equinix.fabric.metro.zh_{:metroCode}.latency`<br>`equinix.fabric.port.bandwidth_rx.usage`<br>`equinix.fabric.port.bandwidth_tx.usage`<br>`equinix.fabric.port.packets_dropped_rx.count`<br>`equinix.fabric.port.packets_dropped_tx.count`<br>`equinix.fabric.port.packets_erred_rx.count`<br>`equinix.fabric.port.packets_erred_tx.count`
+`equinix.fabric.connection.bandwidth_rx.usage`<br>
+`equinix.fabric.connection.bandwidth_tx.usage`<br>
+`equinix.fabric.metro.am_{:metroCode}.latency`<br>
+`equinix.fabric.metro.at_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ba_{:metroCode}.latency`<br>
+`equinix.fabric.metro.bg_{:metroCode}.latency`<br>
+`equinix.fabric.metro.bl_{:metroCode}.latency`<br>
+`equinix.fabric.metro.bo_{:metroCode}.latency`<br>
+`equinix.fabric.metro.bx_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ca_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ch_{:metroCode}.latency`<br>
+`equinix.fabric.metro.cl_{:metroCode}.latency`<br>
+`equinix.fabric.metro.cu_{:metroCode}.latency`<br>
+`equinix.fabric.metro.da_{:metroCode}.latency`<br>
+`equinix.fabric.metro.db_{:metroCode}.latency`<br>
+`equinix.fabric.metro.dc_{:metroCode}.latency`<br>
+`equinix.fabric.metro.de_{:metroCode}.latency`<br>
+`equinix.fabric.metro.dx_{:metroCode}.latency`<br>
+`equinix.fabric.metro.fr_{:metroCode}.latency`<br>
+`equinix.fabric.metro.gv_{:metroCode}.latency`<br>
+`equinix.fabric.metro.he_{:metroCode}.latency`<br>
+`equinix.fabric.metro.hh_{:metroCode}.latency`<br>
+`equinix.fabric.metro.hk_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ho_{:metroCode}.latency`<br>
+`equinix.fabric.metro.il_{:metroCode}.latency`<br>
+`equinix.fabric.metro.jh_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ka_{:metroCode}.latency`<br>
+`equinix.fabric.metro.kl_{:metroCode}.latency`<br>
+`equinix.fabric.metro.la_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ld_{:metroCode}.latency`<br>
+`equinix.fabric.metro.lm_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ls_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ma_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mb_{:metroCode}.latency`<br>
+`equinix.fabric.metro.md_{:metroCode}.latency`<br>
+`equinix.fabric.metro.me_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mi_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ml_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mo_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mt_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mu_{:metroCode}.latency`<br>
+`equinix.fabric.metro.mx_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ny_{:metroCode}.latency`<br>
+`equinix.fabric.metro.os_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ot_{:metroCode}.latency`<br>
+`equinix.fabric.metro.pa_{:metroCode}.latency`<br>
+`equinix.fabric.metro.pe_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ph_{:metroCode}.latency`<br>
+`equinix.fabric.metro.rj_{:metroCode}.latency`<br>
+`equinix.fabric.metro.se_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sg_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sk_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sl_{:metroCode}.latency`<br>
+`equinix.fabric.metro.so_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sp_{:metroCode}.latency`<br>
+`equinix.fabric.metro.st_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sv_{:metroCode}.latency`<br>
+`equinix.fabric.metro.sy_{:metroCode}.latency`<br>
+`equinix.fabric.metro.tr_{:metroCode}.latency`<br>
+`equinix.fabric.metro.ty_{:metroCode}.latency`<br>
+`equinix.fabric.metro.va_{:metroCode}.latency`<br>
+`equinix.fabric.metro.wa_{:metroCode}.latency`<br>
+`equinix.fabric.metro.wi_{:metroCode}.latency`<br>
+`equinix.fabric.metro.zh_{:metroCode}.latency`<br>
+`equinix.fabric.port.bandwidth_rx.usage`<br>
+`equinix.fabric.port.bandwidth_tx.usage`<br>
+`equinix.fabric.port.packets_dropped_rx.count`<br>
+`equinix.fabric.port.packets_dropped_tx.count`<br>
+`equinix.fabric.port.packets_erred_rx.count`<br>
+`equinix.fabric.port.packets_erred_tx.count`
 
 </details>
 
diff --git a/scripts/generate_readme_event_catalog.py b/scripts/generate_readme_event_catalog.py
index 2fffe54..91c4752 100644
--- a/scripts/generate_readme_event_catalog.py
+++ b/scripts/generate_readme_event_catalog.py
@@ -6,11 +6,11 @@ def dropdowns(type, supported):
     dropdowns = "#### " + type
     if len(supported[sc.PREVIEW]) > 0:
         dropdowns += "\n\n<details>\n<summary>In Preview</summary>\n\n"
-        dropdowns += "<br>".join(map(lambda x: f"`{x}`", supported[sc.PREVIEW]))
+        dropdowns += "<br>\n".join(map(lambda x: f"`{x}`", supported[sc.PREVIEW]))
         dropdowns += "\n\n</details>\n\n"
     if len(supported[sc.RELEASED]) > 0:
         dropdowns += "\n\n<details>\n<summary>Released</summary>\n\n"
-        dropdowns += "<br>".join(map(lambda x: f"`{x}`", supported[sc.RELEASED]))
+        dropdowns += "<br>\n".join(map(lambda x: f"`{x}`", supported[sc.RELEASED]))
         dropdowns += "\n\n</details>\n"""
     return dropdowns if len(dropdowns) > 20 else ""