From 72079cc920a2bcfdfd6ede503cce7a0ab18476e9 Mon Sep 17 00:00:00 2001
From: ShahanaFarooqui <shahana.farooqui@gmail.com>
Date: Mon, 24 Jun 2024 17:36:57 -0700
Subject: [PATCH] script: Adding Delete action for readme docs

Documents which are deleted from lightning schema were still listed on readme server.

This script was adding or updating the list but delete action was missing.

Changelog-None.
---
 .github/scripts/sync-rpc-cmds.py | 84 ++++++++++++++++++++------------
 1 file changed, 54 insertions(+), 30 deletions(-)

diff --git a/.github/scripts/sync-rpc-cmds.py b/.github/scripts/sync-rpc-cmds.py
index efb3134d7..47b1b9fe7 100644
--- a/.github/scripts/sync-rpc-cmds.py
+++ b/.github/scripts/sync-rpc-cmds.py
@@ -2,26 +2,30 @@ import os
 from time import sleep
 import requests
 import re
+from enum import Enum
 
 # readme url
-URL = "https://dash.readme.com/api/v1/docs"
+URL = "https://dash.readme.com/api/v1"
 # category id for API reference
 CATEGORY_ID = "63e4e160c60b2e001dd1cc4e"
+CATEGORY_SLUG = "json-rpc-apis"
 
 
-def checkIfDocIsPresent(title, headers):
+class Action(Enum):
+    ADD = 'add'
+    UPDATE = 'update'
+    DELETE = 'delete'
 
-    check_url = URL + "/" + title
-    response = requests.get(check_url, headers=headers)
 
+def getListOfRPCDocs(headers):
+    response = requests.get(f"{URL}/categories/{CATEGORY_SLUG}/docs", headers=headers)
     if response.status_code == 200:
-        return True
+        return response.json()
     else:
-        return False
+        return []
 
 
-def publishDoc(title, body, order):
-    key = os.environ.get("README_API_KEY")
+def publishDoc(action, title, body, order, headers):
     payload = {
         "title": title,
         "type": "basic",
@@ -30,28 +34,30 @@ def publishDoc(title, body, order):
         "hidden": False,
         "order": order,
     }
-    headers = {
-        "accept": "application/json",
-        "content-type": "application/json",
-        "authorization": "Basic " + key,
-    }
-
-    isDocPresent = checkIfDocIsPresent(title, headers)
-    if isDocPresent:
-        # update doc
-        update_url = URL + "/" + title  # title == slug
-        response = requests.put(update_url, json=payload, headers=headers)
-        if response.status_code != 200:
-            print(response.text)
-        else:
-            print("Updated ", title)
-    else:
+    # title == slug
+    if action == Action.ADD:
         # create doc
-        response = requests.post(URL, json=payload, headers=headers)
+        response = requests.post(URL + "/docs", json=payload, headers=headers)
         if response.status_code != 201:
             print(response.text)
         else:
             print("Created ", title)
+    elif action == Action.UPDATE:
+        # update doc
+        response = requests.put(f"{URL}/docs/{title}", json=payload, headers=headers)
+        if response.status_code != 200:
+            print(response.text)
+        else:
+            print("Updated ", title)
+    elif action == Action.DELETE:
+        # delete doc
+        response = requests.delete(f"{URL}/docs/{title}", headers=headers)
+        if response.status_code != 204:
+            print(response.text)
+        else:
+            print("Deleted ", title)
+    else:
+        print("Invalid action")
 
 
 def extract_rpc_commands(rst_content):
@@ -69,19 +75,37 @@ def extract_rpc_commands(rst_content):
 
 
 def main():
+    # define headers for requests
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "authorization": "Basic " + os.environ.get("README_API_KEY"),
+    }
+
     # path to the rst file from where we fetch all the RPC commands
     path_to_rst = "doc/index.rst"
     with open(path_to_rst, "r") as file:
         rst_content = file.read()
 
-    commands = extract_rpc_commands(rst_content)
-    if commands:
+    commands_from_local = extract_rpc_commands(rst_content)
+    commands_from_readme = getListOfRPCDocs(headers)
+
+    # Compare local and server commands list to get the list of command to add or delete
+    commands_local_title = set(command[0] for command in commands_from_local)
+    commands_readme_title = set(command['title'] for command in commands_from_readme)
+    commands_to_delete = commands_readme_title - commands_local_title
+    commands_to_add = commands_local_title - commands_readme_title
+    for name in commands_to_delete:
+        publishDoc(Action.DELETE, name, "", 0, headers)
+        sleep(3)
+
+    if commands_from_local:
         order = 0
-        for name, file in commands:
-            print(f"{name}\t\t{file}")
+        for name, file in commands_from_local:
+            # print(f"{name}\t\t{file}")
             with open("doc/" + file) as f:
                 body = f.read()
-                publishDoc(name, body, order)
+                publishDoc(Action.ADD if name in commands_to_add else Action.UPDATE, name, body, order, headers)
             order = order + 1
             sleep(3)
     else: