fix: resolve comments

Author: Priyadarshini Piramanayagam

docs/getting_started.rst

@@ -260,7 +260,7 @@ TestMonitor API (Results)
 Overview
 ~~~~~~~~
 
-The :class:`.TestMonitorClient` class is the primary entry point of the Result API.
+The :class:`.TestMonitorClient` class is the primary entry point of the Results API.
 
 When constructing a :class:`.TestMonitorClient`, you can pass an
 :class:`.HttpConfiguration` (like one retrieved from the

examples/result/results.py

@@ -48,10 +48,10 @@ def create_some_results():
 create_response = create_some_results()
 
 # Get all the results using the continuation token in batches of 100 at a time.
-response = client.get_results_paged(take=100, return_count=True)
+response = client.get_results(take=100, return_count=True)
 all_results = response.results
 while response.continuation_token:
-    response = client.get_results_paged(
+    response = client.get_results(
         take=100, continuation_token=response.continuation_token, return_count=True
     )
     all_results.extend(response.results)
@@ -63,7 +63,7 @@ def create_some_results():
 query_request = QueryResultsRequest(
     filter=f'status.statusType="{status_type}"', return_count=True
 )
-response = client.query_results_paged(query_request)
+response = client.query_results(query_request)
 
 # Update the first result that you just created and replace the keywords
 updated_result = create_response.results[0]

nisystemlink/clients/testmonitor/_test_monitor_client.py

@@ -67,7 +67,7 @@ def create_results(self, results: List[Result]) -> models.ResultsPartialSuccess:
         "results",
         args=[Query("continuationToken"), Query("take"), Query("returnCount")],
     )
-    def get_results_paged(
+    def get_results(
         self,
         continuation_token: Optional[str] = None,
         take: Optional[int] = None,
@@ -106,9 +106,7 @@ def get_result(self, id: str) -> models.Result:
         ...
 
     @post("query-results")
-    def query_results_paged(
-        self, query: models.QueryResultsRequest
-    ) -> models.PagedResults:
+    def query_results(self, query: models.QueryResultsRequest) -> models.PagedResults:
         """Queries for results that match the filter.
 
         Args:
@@ -142,7 +140,7 @@ def query_result_values(self, query: models.QueryResultValuesRequest) -> List[st
         ...
 
     @post("update-results", args=[Field("results"), Field("replace")])
-    def __update_results(
+    def update_results(
         self, results: List[UpdateResultRequest], replace: bool = False
     ) -> models.ResultsPartialSuccess:
         """Updates a list of results with optional field replacement.
@@ -164,37 +162,6 @@ def __update_results(
         """
         ...
 
-    def update_results(
-        self,
-        results: List[UpdateResultRequest],
-        replace: bool = False,
-        allow_workspace_update: bool = False,
-    ) -> models.ResultsPartialSuccess:
-        """Updates a list of results with optional field replacement.
-
-        Args:
-            `results`: A list of results to update. Results are matched for update by id.
-            `replace`: Replace the existing fields instead of merging them. Defaults to `False`.
-                If this is `True`, then `keywords` and `properties` for the result will be
-                    replaced by what is in the `results` provided in this request.
-                If this is `False`, then the `keywords` and `properties` in this request will
-                    merge with what is already present in the server resource.
-            `allow_workspace_update`: If this is set to `False`, the `workspace` field will be set to None
-                before updating.
-
-        Returns: A list of updates results, results that failed to update, and errors for
-            failures.
-
-        Raises:
-            ApiException: if unable to communicate with the ``/nitestmonitor`` Service
-                or provided an invalid argument.
-        """
-        if not allow_workspace_update:
-            for result in results:
-                result.workspace = None
-
-        return self.__update_results(results, replace)
-
     @delete("results/{id}")
     def delete_result(self, id: str) -> None:
         """Deletes a single result by id.

nisystemlink/clients/testmonitor/models/_result.py

@@ -35,7 +35,7 @@ class StatusObject(JsonModel):
 class Result(JsonModel):
     """Contains information about a result."""
 
-    status: StatusObject
+    status: Optional[StatusObject]
     """The status of the result."""
 
     started_at: Optional[datetime]
@@ -44,7 +44,7 @@ class Result(JsonModel):
     updated_at: Optional[datetime]
     """The last time that this result was updated."""
 
-    program_name: str
+    program_name: Optional[str]
     """The name of the program that generated this result."""
 
     id: Optional[str]

nisystemlink/clients/testmonitor/models/_update_result_request.py

@@ -8,16 +8,16 @@
 class UpdateResultRequest(JsonModel):
     """Contains information about a result."""
 
-    status: StatusObject
+    status: Optional[StatusObject]
     """The status of the result."""
 
     started_at: Optional[datetime]
     """The time that the result started."""
 
-    program_name: str
+    program_name: Optional[str]
     """The name of the program that generated this result."""
 
-    id: Optional[str]
+    id: str
     """The globally unique id of the result."""
 
     system_id: Optional[str]

tests/integration/testmonitor/test_testmonitor.py

@@ -125,7 +125,7 @@ def test__create_single_result_and_get_results__at_least_one_result_exists(
         ]
         create_results(results)
 
-        get_response = client.get_results_paged()
+        get_response = client.get_results()
 
         assert get_response is not None
         assert len(get_response.results) >= 1
@@ -145,7 +145,7 @@ def test__create_multiple_results_and_get_results_with_take__only_take_returned(
         ]
         create_results(results)
 
-        get_response = client.get_results_paged(take=1)
+        get_response = client.get_results(take=1)
 
         assert get_response is not None
         assert len(get_response.results) == 1
@@ -165,7 +165,7 @@ def test__create_multiple_results_and_get_results_with_count_at_least_one_count(
         ]
         create_results(results)
 
-        get_response: PagedResults = client.get_results_paged(return_count=True)
+        get_response: PagedResults = client.get_results(return_count=True)
 
         assert get_response is not None
         assert get_response.total_count is not None and get_response.total_count >= 2
@@ -206,7 +206,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_paged(query_request)
+        query_response: PagedResults = client.query_results(query_request)
         assert query_response.total_count == 1
         assert query_response.results[0].part_number == part_number