From 45b2f9becdcbb3fc9048247e3ad8882849b1d7f1 Mon Sep 17 00:00:00 2001 From: David Butenhof Date: Wed, 20 Oct 2021 07:20:01 -0400 Subject: [PATCH] Comment change --- lib/pbench/server/api/resources/query_apis/__init__.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/pbench/server/api/resources/query_apis/__init__.py b/lib/pbench/server/api/resources/query_apis/__init__.py index b9d0f0444f..a8baf0666b 100644 --- a/lib/pbench/server/api/resources/query_apis/__init__.py +++ b/lib/pbench/server/api/resources/query_apis/__init__.py @@ -463,11 +463,17 @@ def _post(self, json_data: JSON, _) -> Response: """ Perform the requested POST operation, and handle any exceptions. - NOTE: This is called by the ApiBase post() method through its dispatch + This is called by the ApiBase post() method through its dispatch method, which provides parameter validation. + NOTE: This method relies on the "controller" and "name" JSON parameters + being part of the API Schema defined by any subclass that extends this + base class. (This is checked by the constructor.) + Args: json_data: Type-normalized client JSON input + controller: Dataset controller name + name: Dataset name _: Original incoming Request object (not used) Returns: