Add explicit get method on ui_restart endpoint

src/middlewared/middlewared/plugins/system.py

@@ -7,7 +7,8 @@
 from middlewared.logger import CrashReporting
 from middlewared.schema import accepts, Bool, Dict, Int, IPAddr, List, Str
 from middlewared.service import (
-    CallError, ConfigService, no_auth_required, job, pass_app, private, Service, throttle, ValidationErrors
+    CallError, ConfigService, no_auth_required, job, pass_app, private, rest_api_metadata,
+    Service, throttle, ValidationErrors
 )
 import middlewared.sqlalchemy as sa
 from middlewared.utils import Popen, run, start_daemon_thread, sw_buildtime, sw_version, osc
@@ -1470,6 +1471,7 @@ async def do_update(self, data):
 
         return await self.config()
 
+    @rest_api_metadata(extra_methods=['GET'])
     @accepts(Int('delay', default=3, validators=[Range(min=0)]))
     async def ui_restart(self, delay):
         """

src/middlewared/middlewared/restful.py

@@ -142,8 +142,9 @@ async def register_resources(self):
                     res_kwargs['post'] = methodname
                 else:
                     res_kwargs['get'] = methodname
-                for rest_method in (method['explicit_methods'] or []):
-                    assert rest_method in ('post', 'get')
+                for rest_method in map(str.lower, (method['extra_methods'] or [])):
+                    assert rest_method in ('get',)
+                    # Only allow get for now as that's the only use case we have for now NAS-110243
                     res_kwargs[rest_method] = methodname
 
                 Resource(self, self.middleware, short_methodname, service['config'], parent=parent, **res_kwargs)

src/middlewared/middlewared/service.py

@@ -181,7 +181,7 @@ def wrapper(fn):
     return wrapper
 
 
-def rest_api_metadata(explicit_methods=None):
+def rest_api_metadata(extra_methods=None):
     """
     Allow having endpoints specify explicit rest methods.
 
@@ -192,7 +192,7 @@ def rest_api_metadata(explicit_methods=None):
     """
     def wrapper(fn):
         fn._rest_api_metadata = {
-            'explicit_methods': explicit_methods,
+            'extra_methods': extra_methods,
         }
         return fn
     return wrapper
@@ -1087,7 +1087,7 @@ def get_methods(self, service, cli):
                     'filterable': hasattr(method, '_filterable'),
                     'filterable_schema': None,
                     'pass_application': hasattr(method, '_pass_app'),
-                    'explicit_methods': method._rest_api_metadata['explicit_methods'] if hasattr(
+                    'extra_methods': method._rest_api_metadata['extra_methods'] if hasattr(
                         method, '_rest_api_metadata') else None,
                     'require_websocket': hasattr(method, '_pass_app') and not method._pass_app['rest'],
                     'job': hasattr(method, '_job'),