Generate jsonschema for API and CLI

src/carbon_txt/cli.py

@@ -1,7 +1,7 @@
+import json
 import logging
 import os
 import sys
-
 from pathlib import Path
 
 import django
@@ -106,6 +106,14 @@ def validate_file(
     return parsed_result
 
 
+@app.command()
+def schema():
+    schema = CarbonTxtFile.model_json_schema()
+
+    rich.print(json.dumps(schema, indent=2))
+    return schema
+
+
 def configure_django(
     settings_module: str = "carbon_txt.web.config.settings.development",
 ):

src/carbon_txt/web/api.py

@@ -101,3 +101,18 @@ def validate_url(
 
     # Return errors if validation failed
     return {"success": False, "errors": result.errors()}
+
+
+@ninja_api.get(
+    "/json_schema/",
+    summary="Retrieve JSON Schema",
+    description="Get the JSON schema representation of carbon.txt file spec for validation",
+)
+def get_json_schema(request: HttpRequest) -> HttpResponse:
+    """
+    Endpoint to get the JSON schema for a carbon.txt file.
+    """
+    # Get the JSON schema for a carbon.txt file
+    schema = CarbonTxtFile.model_json_schema()
+
+    return schema

tests/test_api_external.py

@@ -2,7 +2,6 @@
 
 import httpx
 import pytest
-import rich
 
 
 @pytest.mark.parametrize("url_suffix", ["", "/"])
@@ -12,7 +11,6 @@ def test_hitting_validate_endpoint_ok(
     api_url = f"{live_server.url}/api/validate/file{url_suffix}"
     data = {"text_contents": shorter_carbon_txt_string}
     res = httpx.post(api_url, json=data, follow_redirects=True)
-    rich.inspect(res)
 
     assert res.status_code == 200
 
@@ -27,7 +25,6 @@ def test_hitting_validate_endpoint_fail(live_server, url_suffix):
         api_url = f"{live_server.url}/api/validate/file{url_suffix}"
         data = {"text_contents": toml_file.read()}
         res = httpx.post(api_url, json=data, follow_redirects=True)
-        rich.inspect(res)
 
         assert res.status_code == 200
 
@@ -37,7 +34,6 @@ def test_hitting_validate_url_endpoint_ok(live_server, url_suffix):
     api_url = f"{live_server.url}/api/validate/url{url_suffix}"
     data = {"url": "https://aremythirdpartiesgreen.com/carbon.txt"}
     res = httpx.post(api_url, json=data, follow_redirects=True)
-    rich.inspect(res)
 
     assert res.status_code == 200
 
@@ -47,6 +43,12 @@ def test_hitting_validate_url_endpoint_fail(live_server, url_suffix):
     api_url = f"{live_server.url}/api/validate/url{url_suffix}"
     data = {"url": "https://aremythirdpartiesgreen.com/carbon.txt"}
     res = httpx.post(api_url, json=data, follow_redirects=True)
-    rich.inspect(res)
 
     assert res.status_code == 200
+
+
+# TODO do we still need to run this with a full on external server?
+def test_hitting_fetch_json_schema(live_server):
+    api_url = f"{live_server.url}/api/json_schema"
+    res = httpx.get(api_url, follow_redirects=True)
+    assert res.status_code == 200

tests/test_cli.py

@@ -1,3 +1,5 @@
+import json
+
 from typer.testing import CliRunner
 
 from carbon_txt.cli import app
@@ -33,3 +35,16 @@ def test_lookup_file(self):
         )
         assert result.exit_code == 0
         assert "https://used-in-tests.carbontxt.org" in result.stdout
+
+    def test_schema(self):
+        """
+        Run our CLI to `carbontxt schema`, and confirm we
+        get back the expected JSON Schema representation of our domain objects
+        """
+
+        result = runner.invoke(app, ["schema"])
+        parsed_schema = json.loads(result.stdout)
+
+        assert result.exit_code == 0
+        assert "CarbonTxtFile" in parsed_schema.get("title")
+        assert "$defs" in parsed_schema.keys()