Fix: PR Comments

Author: Madhan-Reddy-ni

examples/result/results.py

@@ -44,17 +44,17 @@ def create_some_results():
 )
 client = ResultClient(configuration=server_configuration)
 
+create_response = create_some_results()
+
 # Get all the results using the continuation token in batches of 100 at a time.
-response = client.get_results(take=100, return_count=True)
+response = client.get_results_paged(take=100, return_count=True)
 all_results = response.results
 while response.continuation_token:
-    response = client.get_results(
+    response = client.get_results_paged(
         take=100, continuation_token=response.continuation_token, return_count=True
     )
     all_results.extend(response.results)
 
-create_response = create_some_results()
-
 # use get for first result created
 created_result = client.get_result(create_response.results[0].id)
 
@@ -64,7 +64,7 @@ def create_some_results():
     return_count=True,
     order_by=ResultField.HOST_NAME,
 )
-response = client.query_results(query_request)
+response = client.query_results_paged(query_request)
 
 # Update the first result that you just created and replace the keywords
 updated_result = create_response.results[0]

nisystemlink/clients/result/_result_client.py

@@ -52,7 +52,7 @@ def create_results(
         "results",
         args=[Query("continuationToken"), Query("take"), Query("returnCount")],
     )
-    def get_results(
+    def get_results_paged(
         self,
         continuation_token: Optional[str] = None,
         take: Optional[int] = None,
@@ -91,7 +91,7 @@ def get_result(self, id: str) -> models.Result:
         ...
 
     @post("query-results")
-    def query_results(self, query: models.QueryResultsRequest) -> models.PagedResults:
+    def query_results_paged(self, query: models.QueryResultsRequest) -> models.PagedResults:
         """Queries for results that match the filter.
 
         Args:
@@ -113,10 +113,10 @@ def query_result_values(self, query: models.QueryResultValuesRequest) -> List[st
         """Queries for results that match the query and returns a list of the requested field.
 
         Args:
-            query : The query for the fields you want.
+            query : The query for the fields.
 
         Returns:
-            A list of the values of the field you requested.
+            A list of the values of the queried field.
 
         Raises:
             ApiException: if unable to communicate with the ``/nitestmonitor`` Service or provided

tests/integration/result/test_result_client.py

@@ -121,7 +121,7 @@ def test__create_single_result_and_get_results__at_least_one_result_exists(
         ]
         create_results(results)
 
-        get_response = client.get_results()
+        get_response = client.get_results_paged()
 
         assert get_response is not None
         assert len(get_response.results) >= 1
@@ -141,7 +141,7 @@ def test__create_multiple_results_and_get_results_with_take__only_take_returned(
         ]
         create_results(results)
 
-        get_response = client.get_results(take=1)
+        get_response = client.get_results_paged(take=1)
 
         assert get_response is not None
         assert len(get_response.results) == 1
@@ -161,7 +161,7 @@ def test__create_multiple_results_and_get_results_with_count_at_least_one_count(
         ]
         create_results(results)
 
-        get_response: PagedResults = client.get_results(return_count=True)
+        get_response: PagedResults = client.get_results_paged(return_count=True)
 
         assert get_response is not None
         assert get_response.total_count is not None and get_response.total_count >= 2
@@ -202,7 +202,7 @@ def test__query_result_by_part_number__matches_expected(
         query_request = QueryResultsRequest(
             filter=f'partNumber="{part_number}"', return_count=True
         )
-        query_response: PagedResults = client.query_results(query_request)
+        query_response: PagedResults = client.query_results_paged(query_request)
         assert query_response.total_count == 1
         assert query_response.results[0].part_number == part_number