Merge ~lloydwaltersj/maas:servers-openapi-defenition into maas:master

[Jack Lloyd-Walters]

add servers element to OpenApi definition

ee28bf9... by Jack Lloyd-Walters on 2022-07-25

fix docstring

[MAAS Lander (maas-lander)]

UNIT TESTS
-b servers-openapi-defenition lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: bdf630fa69d6d8cadd134e047f1bc2e530e0b338

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b servers-openapi-defenition lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: ee28bf95ee9ed6a2a530cf80d32fd529d3a1c1ef

review: Approve

[Alexsander de Souza (alexsander-souza)]

+1

review: Approve

diff --git a/src/maasserver/api/doc_oapi.py b/src/maasserver/api/doc_oapi.py
index d9dfe25..2b20e54 100644
--- a/src/maasserver/api/doc_oapi.py
+++ b/src/maasserver/api/doc_oapi.py
@@ -6,6 +6,7 @@ import json
 from django.http import HttpResponse
 import yaml
 
+from maasserver.models.config import Config
 from maasserver.utils import build_absolute_uri
 
 
@@ -32,12 +33,10 @@ def endpoint(request):
         with the OpenApi spec 3.0.
     """
     description = get_api_endpoint()
-    doc = description["externalDocs"]
-    doc["url"] = build_absolute_uri(request, doc["url"])
     # Return as a YAML document
     return HttpResponse(
         yaml.dump(description),
-        content_type="application/yaml",
+        content_type="application/openapi+yaml",
     )
 
 
@@ -81,4 +80,18 @@ def get_api_endpoint():
             "url": "/MAAS/docs/api.html",
         },
     }
+    description["servers"] = _get_maas_servers()
     return description
+
+
+def _get_maas_servers():
+    """Return a servers defintion of the public-facing MAAS address.
+
+    :return: An object describing the MAAS public-facing server.
+    """
+    maas_url = Config.objects.get_config("maas_url")
+    maas_name = Config.objects.get_config("maas_name")
+    return {
+        "url": f"{maas_url}/api/2.0",
+        "description": f"{maas_name} API",
+    }
diff --git a/src/maasserver/api/tests/test_doc.py b/src/maasserver/api/tests/test_doc.py
index ad02930..70ffa40 100644
--- a/src/maasserver/api/tests/test_doc.py
+++ b/src/maasserver/api/tests/test_doc.py
@@ -49,8 +49,10 @@ from maasserver.api.support import (
     OperationsHandler,
     OperationsResource,
 )
+from maasserver.models.config import Config
 from maasserver.testing.config import RegionConfigurationFixture
 from maasserver.testing.factory import factory
+from maasserver.testing.testcase import MAASServerTestCase
 from maastesting.matchers import IsCallable
 from maastesting.testcase import MAASTestCase
 from provisioningserver.drivers.pod.registry import PodDriverRegistry
@@ -95,7 +97,7 @@ class TestLandingPage(MAASTestCase):
         self.assertEqual(resources[0]["type"], page["content-type"])
 
 
-class TestApiEndpoint(MAASTestCase):
+class TestApiEndpoint(MAASServerTestCase):
     def test_required_fields(self):
         request = factory.make_fake_request()
         page = endpoint(request)
@@ -108,6 +110,17 @@ class TestApiEndpoint(MAASTestCase):
         self.assertIn("title", info)
         self.assertIn("version", info)
 
+    def test_discovered_servers(self):
+        request = factory.make_fake_request()
+        page = endpoint(request)
+        content = yaml.safe_load(page.content)
+        self.assertIn("servers", content)
+        servers = content["servers"]
+        maas_name = Config.objects.get_config("maas_name")
+        maas_url = Config.objects.get_config("maas_url")
+        self.assertEqual(servers["url"], f"{maas_url}/api/2.0")
+        self.assertEqual(servers["description"], f"{maas_name} API")
+
 
 class TestFindingResources(MAASTestCase):
     """Tests for API inspection support: finding resources."""