Merge ~lloydwaltersj/maas:update-required into maas:master

[Jack Lloyd-Walters]

ensure parameters in path are required

A parameter found in the operation path ie: "id" in "/vm-clusters/{id}" should be marked as required.

1c3c727... by Jack Lloyd-Walters on 2022-08-26

remove unrelated changes

3d44377... by Jack Lloyd-Walters on 2022-08-26

add explicit checking for requirement field

[MAAS Lander (maas-lander)]

UNIT TESTS
-b update-required lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 1c3c727eb4ae058ca8c567eb94449f6787f32106

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b update-required lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 3d44377d461160f2a1b0a459b91731f5b8893ec4

review: Approve

98daadf... by Jack Lloyd-Walters on 2022-08-26

revert yaml.dump change

[MAAS Lander (maas-lander)]

UNIT TESTS
-b update-required lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 98daadf2eafb3cc05ee3baac31f172f93d4b17f2

review: Approve

[Alberto Donato (ack)]

lgtm

review: Approve

diff --git a/src/maasserver/api/doc_oapi.py b/src/maasserver/api/doc_oapi.py
index c579acd..25922cd 100644
--- a/src/maasserver/api/doc_oapi.py
+++ b/src/maasserver/api/doc_oapi.py
@@ -205,7 +205,10 @@ def _oapi_item_from_docstring(function, http_method, uri_params):
         for param in ap_dict["params"]:
             description = _prettify(param["description_stripped"])
             name = param["name"].strip("}{")
-            required = param["options"]["required"].lower() == "true"
+            required = (
+                param["options"]["required"].lower() == "true"
+                or name != param["name"]
+            )
             if param["name"][0] == "{":
                 param_dict = {
                     "name": name,
diff --git a/src/maasserver/api/license_keys.py b/src/maasserver/api/license_keys.py
index ce95254..0daec6c 100644
--- a/src/maasserver/api/license_keys.py
+++ b/src/maasserver/api/license_keys.py
@@ -165,10 +165,10 @@ class LicenseKeyHandler(OperationsHandler):
         @description Delete license key for the given operation system and
         distro series.
 
-        @param (string) "{osystem}" [required=false] Operating system that the
+        @param (string) "{osystem}" [required=true] Operating system that the
         key belongs to.
 
-        @param (string) "{distro_series}" [required=false] OS release that the
+        @param (string) "{distro_series}" [required=true] OS release that the
         key belongs to.
 
         @success (http-status-code) "server-success" 204
diff --git a/src/maasserver/api/pods.py b/src/maasserver/api/pods.py
index f4bfbea..8af6775 100644
--- a/src/maasserver/api/pods.py
+++ b/src/maasserver/api/pods.py
@@ -200,7 +200,7 @@ class VmHostHandler(OperationsHandler):
         @description Performs VM host discovery and updates all discovered
         information and discovered machines.
 
-        @param (int) "{id}" [required=false] The VM host's ID.
+        @param (int) "{id}" [required=true] The VM host's ID.
 
         @success (json) "success-json" A VM host JSON object.
         @success-example "success-json" [exkey=refresh-vmhost] placeholder text
diff --git a/src/maasserver/management/commands/generate_oapi_spec.py b/src/maasserver/management/commands/generate_oapi_spec.py
index 5299fcc..096d779 100644
--- a/src/maasserver/management/commands/generate_oapi_spec.py
+++ b/src/maasserver/management/commands/generate_oapi_spec.py
@@ -3,7 +3,6 @@
 
 """Django command: generate the Open API specification."""
 
-
 from django.core.management.base import BaseCommand
 import yaml