Merge ~lloydwaltersj/maas:oapi-include-more-methods into maas:master

[Jack Lloyd-Walters]

Modify OpenApi method generation to capture all method types

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/2030/consoleText
COMMIT: 56b0ff3eab2bdb7143381fd809f66de11fab57de

review: Needs Fixing

[Adam Collard (adam-collard)]

https://paste.ubuntu.com/p/tDZ9vnfPPN/

c46bacb... by Jack Lloyd-Walters on 2023-03-01

fix duplicate parameter names

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: c46bacb93fb827e64feb491b6e0721f7fe7e2914

review: Approve

cd59eb5... by Jack Lloyd-Walters on 2023-03-01

Remove curly brace

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

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

review: Needs Fixing

081a49a... by Jack Lloyd-Walters on 2023-03-02

remove uri_variables from request body

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 081a49adc3893bd5cdb7b12bff4bf5878b769678

review: Approve

1713712... by Jack Lloyd-Walters on 2023-03-02

use path_var in "in" section of schema

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 1713712413ea2b60f985b7cdd97ee2020aa4645b

review: Approve

[Adam Collard (adam-collard)]

https://paste.ubuntu.com/p/Zd825qYZDv/

Looks good!

review: Approve

[Adam Collard (adam-collard)]

review: Needs Fixing

1195a41... by Jack Lloyd-Walters on 2023-03-03

modify parameters generation

[Adam Collard (adam-collard)]

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b oapi-include-more-methods lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 1195a41839dd8cc0966e0cde9a3c6c888e32cfca

review: Approve

diff --git a/src/maasserver/api/doc_oapi.py b/src/maasserver/api/doc_oapi.py
index e252bbc..b7e3a9d 100644
--- a/src/maasserver/api/doc_oapi.py
+++ b/src/maasserver/api/doc_oapi.py
@@ -214,14 +214,16 @@ def _oapi_item_from_docstring(
         for param in ap_dict["params"]:
             description = _prettify(param["description_stripped"])
             name = param["name"].strip("}{")
+            path_var = name in uri_params
             required = (
                 param["options"]["required"].lower() == "true"
                 or name != param["name"]
             )
-            if param["name"][0] == "{":
+            # params with special charcters in names don't form part of the request body
+            if name != param["name"]:
                 param_dict = {
                     "name": name,
-                    "in": "path" if name in uri_params else "query",
+                    "in": "path" if path_var else "query",
                     "description": description,
                     "schema": {
                         "type": _type_to_string(param["type"]),
@@ -229,15 +231,11 @@ def _oapi_item_from_docstring(
                     "required": required,
                 }
                 oper_obj.setdefault("parameters", []).append(param_dict)
-            elif http_method.lower() in ("put", "post"):
-                body.setdefault("properties", {}).update(
-                    {
-                        name: {
-                            "description": description,
-                            "type": _type_to_string(param["type"]),
-                        }
-                    }
-                )
+            else:
+                body.setdefault("properties", {})[name] = {
+                    "description": description,
+                    "type": _type_to_string(param["type"]),
+                }
                 if required:
                     body.setdefault("required", []).append(name)