Merge pull request #252 from Myrausman/issue-27

Update docstring to specify return type as Json object
zowe · Feb 16, 2024 · 3cf2cd0 · 3cf2cd0
2 parents 09a10d1 + 848bc90
commit 3cf2cd0
Showing 1 changed file with 13 additions and 13 deletions.
diff --git a/src/zos_jobs/zowe/zos_jobs_for_zowe_sdk/jobs.py b/src/zos_jobs/zowe/zos_jobs_for_zowe_sdk/jobs.py
@@ -72,7 +72,7 @@ def cancel_job(self, jobname: str, jobid: str, modify_version="2.0"):
         Returns
         -------
         response_json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if modify_version not in ("1.0", "2.0"):
             raise ValueError('Accepted values for modify_version: "1.0" or "2.0"')
@@ -101,7 +101,7 @@ def delete_job(self, jobname, jobid, modify_version="2.0"):
         Returns
         -------
         response_json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if modify_version not in ("1.0", "2.0"):
             raise ValueError('Accepted values for modify_version: "1.0" or "2.0"')
@@ -142,7 +142,7 @@ def change_job_class(self, jobname: str, jobid: str, class_name: str, modify_ver
         Returns
         -------
         response_json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if modify_version not in ("1.0", "2.0"):
             raise ValueError('Accepted values for modify_version: "1.0" or "2.0"')
@@ -165,7 +165,7 @@ def hold_job(self, jobname: str, jobid: str, modify_version="2.0"):
         Returns
         -------
         response_json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if modify_version not in ("1.0", "2.0"):
             raise ValueError('Accepted values for modify_version: "1.0" or "2.0"')
@@ -188,7 +188,7 @@ def release_job(self, jobname: str, jobid: str, modify_version="2.0"):
         Returns
         -------
         response_json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if modify_version not in ("1.0", "2.0"):
             raise ValueError('Accepted values for modify_version: "1.0" or "2.0"')
@@ -213,7 +213,7 @@ def list_jobs(self, owner=None, prefix="*", max_jobs=1000, user_correlator=None)
         Returns
         -------
         json
-            A JSON containing a list of jobs on JES queue based on the given parameters
+            A JSON object containing a list of jobs on JES queue based on the given parameters
         """
         custom_args = self._create_custom_request_arguments()
         params = {"prefix": prefix, "max-jobs": max_jobs}
@@ -236,7 +236,7 @@ def submit_from_mainframe(self, jcl_path):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         custom_args = self._create_custom_request_arguments()
         request_body = {"file": "//'%s'" % jcl_path}
@@ -264,7 +264,7 @@ def submit_from_local_file(self, jcl_path):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         if os.path.isfile(jcl_path):
             with open(jcl_path, "r", encoding="utf-8") as jcl_file:
@@ -284,7 +284,7 @@ def submit_plaintext(self, jcl):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         custom_args = self._create_custom_request_arguments()
         custom_args["data"] = str(jcl)
@@ -303,7 +303,7 @@ def get_spool_files(self, correlator):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files".format(correlator)
@@ -322,7 +322,7 @@ def get_jcl_text(self, correlator):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files/JCL/records".format(correlator)
@@ -346,7 +346,7 @@ def get_spool_file_contents(self, correlator, id):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
         custom_args = self._create_custom_request_arguments()
         job_url = "{}/files/{}/records".format(correlator, id)
@@ -384,7 +384,7 @@ def get_job_output_as_files(self, status, output_dir):
         Returns
         -------
         json
-            A JSON containing the result of the request execution
+            A JSON object containing the result of the request execution
         """
 
         job_name = status["jobname"]