Merge ~lloydwaltersj/maas:fix-oapi-docs into maas:master

[Jack Lloyd-Walters]

Add oapi spec to makefile for external usage

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/271/consoleText
COMMIT: 1f7779db0113d9e0925d279f31449bafd8aa6298

review: Needs Fixing

23a1cb3... by Jack Lloyd-Walters on 2022-08-05

fix leftover argument

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/272/consoleText
COMMIT: 23a1cb3260ef16b9443af2ca23b979f0f8da5130

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/273/consoleText
COMMIT: 23a1cb3260ef16b9443af2ca23b979f0f8da5130

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/274/consoleText
COMMIT: 23a1cb3260ef16b9443af2ca23b979f0f8da5130

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

I have no idea what's happening here

[Jack Lloyd-Walters (lloydwaltersj)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/275/consoleText
COMMIT: 23a1cb3260ef16b9443af2ca23b979f0f8da5130

review: Needs Fixing

[Alexsander de Souza (alexsander-souza)]

please change the file name

review: Needs Fixing

00ce99a... by Jack Lloyd-Walters on 2022-08-15

change filename

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/315/consoleText
COMMIT: 00ce99a9c4653ca5fd70d7b12a6018aeb5faadbb

review: Needs Fixing

[Alexsander de Souza (alexsander-souza)]

+1

review: Approve

[Adam Collard (adam-collard)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/324/consoleText
COMMIT: 00ce99a9c4653ca5fd70d7b12a6018aeb5faadbb

review: Needs Fixing

8605451... by Jack Lloyd-Walters on 2022-08-16

switch to lambda expression

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/328/consoleText
COMMIT: 8605451efb8340487131676b3f076e713ff9e06d

review: Needs Fixing

9fd1f8d... by Jack Lloyd-Walters on 2022-08-17

checking without context

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/331/consoleText
COMMIT: 9fd1f8d033a62ca0947698acae55889ac3402a23

review: Needs Fixing

35e1728... by Jack Lloyd-Walters on 2022-08-17

fix twisted error

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/332/consoleText
COMMIT: 35e1728e3a9260804da8eaa521aecb1eac8f4163

review: Needs Fixing

e286c8a... by Jack Lloyd-Walters on 2022-08-17

trim unnecesary function

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/333/consoleText
COMMIT: e286c8a0c9b3098133712b49c0f38abb88051c97

review: Needs Fixing

77f804f... by Jack Lloyd-Walters on 2022-08-17

bring branch up to parity

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/334/consoleText
COMMIT: c28cb28e59b4e09d06467029fbccbe0981c404a0

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/335/consoleText
COMMIT: 301eaf5f6e2be7f32a646c23c0caf788c7b54c93

review: Needs Fixing

[Adam Collard (adam-collard)]

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/336/consoleText
COMMIT: 4cdc996aafa309d27745e980c7d079e4bbc9d079

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/337/consoleText
COMMIT: a0318b288a36740969a4cc473512870d6d69f505

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: a0318b288a36740969a4cc473512870d6d69f505

review: Approve

[Adam Collard (adam-collard)]

review: Needs Fixing

7c3d2f1... by Jack Lloyd-Walters on 2022-08-17

fix problem with submodule

424bd8e... by Jack Lloyd-Walters on 2022-08-17

change name in gitignore too

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 7c3d2f17c0a5937afc6bd577b2fced474b46627b

review: Approve

397e0ee... by Jack Lloyd-Walters on 2022-08-17

remove hash form CSS

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/344/consoleText
COMMIT: 397e0eea564944b6f04188aeb032d1749df5aa2a

review: Needs Fixing

f011fa0... by Jack Lloyd-Walters on 2022-08-17

linting and formating

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: f011fa0bf1232cfee822e6411b7030eb1c18b16f

review: Approve

[Adam Collard (adam-collard)]

review: Approve

2800e6e... by Jack Lloyd-Walters on 2022-08-17

change output stream for yaml dump

[MAAS Lander (maas-lander)]

UNIT TESTS
-b fix-oapi-docs lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 2800e6eef6cddee649e2ca135c4c9b5a03ab30d7

review: Approve

diff --git a/.gitignore b/.gitignore
index d84ca68..31cd627 100644
--- a/.gitignore
+++ b/.gitignore
@@ -26,6 +26,7 @@
 /develop-eggs
 /dist
 /api-docs.rst
+/openapi.yaml
 /eggs
 /etc/maas/rackd.conf
 /etc/maas/regiond.conf
diff --git a/Makefile b/Makefile
index cd8f092..5a5c2af 100644
--- a/Makefile
+++ b/Makefile
@@ -218,7 +218,10 @@ check: clean test
 api-docs.rst: bin/maas-region src/maasserver/api/doc_handler.py syncdb
 	bin/maas-region generate_api_doc > $@
 
-doc: api-docs.rst
+openapi.yaml: bin/maas-region src/maasserver/api/doc_handler.py syncdb
+	bin/maas-region generate_oapi_spec > $@
+
+doc: api-docs.rst openapi.yaml
 .PHONY: doc
 
 .run: run-skel
diff --git a/src/maasserver/api/doc_oapi.py b/src/maasserver/api/doc_oapi.py
index d747499..1676c57 100644
--- a/src/maasserver/api/doc_oapi.py
+++ b/src/maasserver/api/doc_oapi.py
@@ -19,35 +19,9 @@ from maasserver.api.annotations import APIDocstringParser
 from maasserver.api.doc import find_api_resources, generate_doc
 from maasserver.djangosettings import settings
 from maasserver.models.config import Config
-from maasserver.models.controllerinfo import get_maas_version
 from maasserver.utils import build_absolute_uri
 
 
-def openapi_docs_context(request):
-    """Return the aadditional context needed for the oapi doc template to function"""
-    colourmap = {
-        "bark": "#585841",
-        "blue": "#0060bf",
-        "magenta": "#974097",
-        "olive": "#3d5f11",
-        "prussian green": "#225d5c",
-        "purple": "#7764d8",
-        "red": "#a71b33",
-        "sage": "#4e5f51",
-        "viridian": "#025a3d",
-    }
-    local_server = _get_maas_servers()[0]
-    context = {
-        "openapi_url": local_server["url"] + "openapi.yaml",
-        "maas_colour": colourmap.get(
-            Config.objects.get_config("theme").lower(), "#262626"
-        ),
-        "maas_name": local_server["description"].removesuffix(" API"),
-        "maas_version": get_maas_version(),
-    }
-    return context
-
-
 def landing_page(request):
     """Render a landing page with pointers for the MAAS API.
 
@@ -71,6 +45,7 @@ def endpoint(request):
         with the OpenApi spec 3.0.
     """
     description = get_api_endpoint()
+    description["servers"] = _get_maas_servers()
     # Return as a YAML document
     return HttpResponse(
         yaml.dump(description),
@@ -125,7 +100,6 @@ def get_api_endpoint():
             "description": "MAAS API documentation",
             "url": "/MAAS/docs/api.html",
         },
-        "servers": _get_maas_servers(),
     }
     return description
 
diff --git a/src/maasserver/api/tests/test_oapi.py b/src/maasserver/api/tests/test_oapi.py
index 641726d..0e27da9 100644
--- a/src/maasserver/api/tests/test_oapi.py
+++ b/src/maasserver/api/tests/test_oapi.py
@@ -5,12 +5,7 @@ import json
 
 import yaml
 
-from maasserver.api.doc_oapi import (
-    _render_oapi_paths,
-    endpoint,
-    landing_page,
-    openapi_docs_context,
-)
+from maasserver.api.doc_oapi import _render_oapi_paths, endpoint, landing_page
 from maasserver.models.config import Config
 from maasserver.testing.factory import factory
 from maasserver.testing.testcase import MAASServerTestCase
@@ -58,18 +53,6 @@ class TestApiEndpoint(MAASServerTestCase):
         self.assertEqual(maasserver["description"], f"{maas_name} API")
 
 
-class TestOAPIDocs(MAASServerTestCase):
-    def test_docs_point_to_api(self):
-        request = factory.make_fake_request()
-        page = landing_page(request)
-        content = json.loads(page.content)
-        oapi_res = content["resources"][1]
-        context = openapi_docs_context(request)
-        self.assertEqual(
-            context["openapi_url"], f"http://localhost:5240{oapi_res['path']}"
-        )
-
-
 class TestOAPISpec(MAASServerTestCase):
     def setUp(self):
         self.oapi_types = ["boolean", "integer", "number", "object", "string"]
diff --git a/src/maasserver/management/commands/generate_oapi_spec.py b/src/maasserver/management/commands/generate_oapi_spec.py
new file mode 100644
index 0000000..5299fcc
--- /dev/null
+++ b/src/maasserver/management/commands/generate_oapi_spec.py
@@ -0,0 +1,17 @@
+# Copyright 2022 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Django command: generate the Open API specification."""
+
+
+from django.core.management.base import BaseCommand
+import yaml
+
+from maasserver.api.doc_oapi import get_api_endpoint
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        oapi = get_api_endpoint()
+        oapi["externalDocs"]["url"] = "https://maas.io/docs"
+        yaml.dump(oapi, self.stdout)
diff --git a/src/maasserver/templates/openapi.html b/src/maasserver/templates/openapi.html
index 5381de5..41c492b 100644
--- a/src/maasserver/templates/openapi.html
+++ b/src/maasserver/templates/openapi.html
@@ -4,8 +4,8 @@
   <head>
     <meta charset="UTF-8">
     <title>MAAS API</title>
-    <link href="/MAAS/r/static/css/main.05850fff.css" rel="stylesheet">
-    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css" />
+    <link href="https://maas.io/static/css/main.css" rel="stylesheet">
+    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@latest/swagger-ui.css" />
     <style>
       html * {
         font-family: ubuntu !important;
@@ -23,7 +23,7 @@
   </head>
 
   <body>
-    <header class="p-navigation is-dark" style="background-color: {{ maas_colour }};">
+    <header class="p-navigation is-dark" style="background-color: #262626;">
       <div class="p-navigation__row">
         <div class="p-navigation__banner">
           <div class="p-navigation__tagged-logo">
@@ -45,16 +45,16 @@
         </div>
         <div style="margin: auto; margin-right:0;">
           <a aria-label="Homepage" class="p-navigation__link" href="/MAAS/api/">
-            <div class="p-navigation__logo-title">{{ maas_name }} MAAS: {{ maas_version }}</div>
+            <div class="p-navigation__logo-title">MAAS</div>
           </a>
         </div>
       </header>
-    <div id="swagger-ui" style="max-width: 90rem; margin: auto;"></div>
-    <script src="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui-bundle.js" crossorigin></script>
+    <div id="swagger-ui" style="max-width: 72rem; margin: auto;"></div>
+    <script src="https://unpkg.com/swagger-ui-dist@latest/swagger-ui-bundle.js" crossorigin></script>
     <script>
       window.onload = function() {
         window.ui = SwaggerUIBundle({
-          url: "{{ openapi_url }}",
+          url: "/MAAS/api/2.0/openapi.yaml",
           dom_id: '#swagger-ui',
           deepLinking: true,
           presets: [
diff --git a/src/maasserver/urls.py b/src/maasserver/urls.py
index 63ef2ec..2f3169c 100644
--- a/src/maasserver/urls.py
+++ b/src/maasserver/urls.py
@@ -9,7 +9,7 @@ from django.urls import include, re_path
 from django.views.generic import TemplateView
 
 from maasserver import urls_api
-from maasserver.api.doc_oapi import landing_page, openapi_docs_context
+from maasserver.api.doc_oapi import landing_page
 from maasserver.bootresources import (
     simplestreams_file_handler,
     simplestreams_stream_handler,
@@ -78,13 +78,7 @@ urlpatterns += [re_path(r"^accounts/logout/$", logout, name="logout")]
 # API URLs. If old API requested, provide error message directing to new API.
 urlpatterns += [
     re_path(r"^api/$", landing_page),
-    re_path(
-        r"^api/docs/",
-        lambda request: TemplateView.as_view(
-            template_name="openapi.html",
-            extra_context=openapi_docs_context(request),
-        ),
-    ),
+    re_path(r"^api/docs/", TemplateView.as_view(template_name="openapi.html")),
     re_path(r"^api/2\.0/", include(urls_api)),
     re_path(
         r"^api/version/",