Feature: Add a launcher to view the corresponding api spec of the action

Author: IamLunchbox

powerdns_cli/powerdns_cli.py

@@ -251,6 +251,13 @@ def autoprimary_list(ctx):
     raise SystemExit(1)
 
 
+@autoprimary.command("spec")
+def autoprimary_spec():
+    """Open the autoprimary specification on https://redocly.github.io"""
+
+    utils.open_spec("autoprimary")
+
+
 @cli.group()
 def config():
     """Overall server configuration"""
@@ -295,6 +302,13 @@ def config_stats(ctx):
     raise SystemExit(1)
 
 
+@config.command("spec")
+def config_spec():
+    """Open the config specification on https://redocly.github.io"""
+
+    utils.open_spec("config")
+
+
 @cli.group()
 def cryptokey():
     """Configure cryptokeys"""
@@ -541,6 +555,13 @@ def cryptokey_publish(ctx, dns_zone, cryptokey_id):
     raise SystemExit(1)
 
 
+@cryptokey.command("spec")
+def cryptokey_spec():
+    """Open the cryptokey specification on https://redocly.github.io"""
+
+    utils.open_spec("cryptokey")
+
+
 @cryptokey.command("unpublish")
 @click.pass_context
 @click.argument("dns_zone", type=PowerDNSZone, metavar="zone")
@@ -663,6 +684,13 @@ def network_delete(ctx, cidr):
     raise SystemExit(1)
 
 
+@network.command("spec")
+def network_spec():
+    """Open the network specification on https://redocly.github.io"""
+
+    utils.open_spec("network")
+
+
 @cli.group()
 def record():
     """Resource records of a zone"""
@@ -1020,6 +1048,12 @@ def record_export(
     raise SystemExit(1)
 
 
+@record.command("spec")
+def record_spec():
+    """Open the record specification on https://redocly.github.io"""
+    utils.open_spec("record")
+
+
 @cli.group()
 def tsigkey():
     """Set up tsigkeys"""
@@ -1118,6 +1152,13 @@ def tsigkey_list(ctx):
     raise SystemExit(1)
 
 
+@tsigkey.command("spec")
+def tsigkey_spec():
+    """Open the tsigkey specification on https://redocly.github.io"""
+
+    utils.open_spec("tsigkey")
+
+
 @tsigkey.command("update")
 @click.argument("name", type=click.STRING)
 @click.option(
@@ -1306,6 +1347,13 @@ def zone_rectify(ctx, dns_zone):
     raise SystemExit(1)
 
 
+@zone.command("spec")
+def zone_spec():
+    """Open the zone specification on https://redocly.github.io"""
+
+    utils.open_spec("zone")
+
+
 @zone.command("search")
 @click.argument("search-string", metavar="STRING")
 @click.option("--max", "max_output", help="Number of items to output", default=5, type=click.INT)
@@ -1430,6 +1478,12 @@ def metadata_list(ctx, dns_zone, limit):
     raise SystemExit(1)
 
 
+@metadata.command("spec")
+def metadata_spec():
+    """Open the metadata specification on https://redocly.github.io"""
+    utils.open_spec("metadata")
+
+
 @metadata.command("update")
 @click.argument("dns_zone", type=PowerDNSZone, metavar="zone")
 @click.argument("metadata-key", type=click.STRING)
@@ -1542,6 +1596,13 @@ def view_list(ctx):
     raise SystemExit(1)
 
 
+@view.command("spec")
+def view_spec():
+    """Open the view specification on https://redocly.github.io"""
+
+    utils.open_spec("view")
+
+
 # pylint: disable=unused-argument
 @view.command("update")
 @click.argument("view_id", type=click.STRING, metavar="view")

powerdns_cli/utils.py

@@ -240,3 +240,38 @@ def merge_rrsets(uri: str, ctx: click.Context, new_rrset: dict) -> list:
                 ]
             )
     return merged_rrsets
+
+
+def open_spec(action: str) -> SystemExit:
+    """Opens the api spec on https://redocly.github.io with your default browser"""
+    action = action.lower()
+    match action:
+        case "autoprimary":
+            tag = "/autoprimary"
+        case "cryptokey":
+            tag = "/zonecryptokey"
+        case "config":
+            tag = "/config"
+        case "metadata":
+            tag = "/zonemetadata"
+        case "network":
+            tag = "/networks"
+        case "record":
+            tag = "/zones/operation/patchZone"
+        case "search":
+            tag = "/search"
+        case "tsigkey":
+            tag = "/tsigkey"
+        case "view":
+            tag = "/views"
+        case "zone":
+            tag = "/zones"
+        case _:
+            tag = ""
+    url = (
+        f"https://redocly.github.io/redoc/?url="
+        f"https://raw.githubusercontent.com/PowerDNS/pdns/"
+        f"refs/heads/master/docs/http-api/swagger/authoritative-api-swagger.yaml"
+        f"#tag{tag}"
+    )
+    raise SystemExit(click.launch(url))

pyproject.toml

@@ -13,7 +13,7 @@ license = "GPL-3.0-or-later"
 classifiers = [
     "Programming Language :: Python :: 3",
 ]
-version = "0.0.18"
+version = "0.0.19"
 dependencies = [
     "requests==2.32.5",
     "click==8.2.1"