Fix PR comments

Author: Suganth Sadaiyappan

docs/getting_started.rst

@@ -278,6 +278,12 @@ Examples
 
 Create, query, update, and delete some results
 
-.. literalinclude:: ../examples/result/results.py
+.. literalinclude:: ../examples/testmonitor/results.py
+   :language: python
+   :linenos:
+
+Create, update, query, and delete steps
+
+.. literalinclude:: ../examples/testmonitor/steps.py
    :language: python
    :linenos:

examples/testmonitor/steps.py

@@ -1,6 +1,5 @@
 from nisystemlink.clients.testmonitor import TestMonitorClient
 from nisystemlink.clients.testmonitor.models import (
-    CreateMultipleStepsRequest,
     CreateResultRequest,
     CreateStepRequest,
     NamedValue,
@@ -9,9 +8,9 @@
     Status,
     StepField,
     StepIdResultIdPair,
-    UpdateMultipleStepsRequest,
     UpdateStepRequest,
 )
+from nisystemlink.clients.testmonitor.models._step_data import Measurement, StepData
 
 
 def create_test_result():
@@ -64,7 +63,7 @@ def create_test_result():
 ]
 
 # Create the steps
-create_response = client.create_steps(CreateMultipleStepsRequest(steps=step_requests))
+create_response = client.create_steps(steps=step_requests)
 created_steps = create_response.steps
 print(create_response)
 
@@ -86,16 +85,27 @@ def create_test_result():
 
 # update the name of a step
 update_response = client.update_steps(
-    UpdateMultipleStepsRequest(
-        steps=[
-            UpdateStepRequest(
-                step_id=step.step_id,
-                result_id=step.result_id,
-                name="updated name",
-            )
-            for step in created_steps
-        ]
-    )
+    steps=[
+        UpdateStepRequest(
+            step_id=step.step_id,
+            result_id=step.result_id,
+            data=StepData(
+                text="My output string",
+                parameters=[
+                    Measurement(
+                        name="Temperature",
+                        status=Status.PASSED(),
+                        measurement="35",
+                        lowLimit="30",
+                        highLimit="40",
+                        units="C",
+                        comparisonType="Numeric",
+                    )
+                ],
+            ),
+        )
+        for step in created_steps
+    ]
 )
 
 # delete all steps at once
@@ -106,7 +116,7 @@ def create_test_result():
     ]
 )
 
-create_response = client.create_steps(CreateMultipleStepsRequest(steps=step_requests))
+create_response = client.create_steps(steps=step_requests)
 created_steps = create_response.steps
 
 # delete steps one by one

nisystemlink/clients/testmonitor/_test_monitor_client.py

@@ -198,14 +198,21 @@ def delete_results(
         """
         ...
 
-    @post("steps")
+    @post(
+        "steps",
+        args=[Field("steps"), Field("updateResultTotalTime")],
+    )
     def create_steps(
-        self, steps: models.CreateMultipleStepsRequest
+        self,
+        steps: List[models.CreateStepRequest],
+        update_result_total_time: Optional[bool] = False,
     ) -> models.CreateStepsPartialSuccess:
         """Creates one or more steps.
 
         Args:
             steps: A list of steps to create.
+            update_result_total_time: Determine test result total time from the step total times.
+                Defaults to False.
 
         Returns:
             A list of steps that were successfully created and ones that failed to be created.
@@ -235,6 +242,33 @@ def delete_steps(
         """
         ...
 
+    @delete(
+        "results/{resultId}/steps/{stepId}",
+        args=[Path("resultId"), Path("stepId"), Query("updateResultTotalTime")],
+    )
+    def delete_step(
+        self,
+        result_id: str,
+        step_id: str,
+        update_result_total_time: Optional[bool] = False,
+    ) -> None:
+        """Deletes a single step.
+
+        Args:
+            result_id: The resultId of the step to delete.
+            step_id: The stepId of the step to delete.
+            update_result_total_time: Determine test result total time from the step total times.
+                Defaults to False.
+
+        Returns:
+            None
+
+        Raises:
+            ApiException: if unable to communicate with the `/nitestmonitor` service or if there are
+            invalid arguments.
+        """
+        ...
+
     @post("query-steps")
     def query_steps(self, query: models.QueryStepsRequest) -> models.PagedSteps:
         """Queries for steps that match the filters.
@@ -251,9 +285,21 @@ def query_steps(self, query: models.QueryStepsRequest) -> models.PagedSteps:
         """
         ...
 
-    @post("update-steps")
+    @post(
+        "update-steps",
+        args=[
+            Field("steps"),
+            Field("updateResultTotalTime"),
+            Field("replaceKeywords"),
+            Field("replaceProperties"),
+        ],
+    )
     def update_steps(
-        self, steps: models.UpdateMultipleStepsRequest
+        self,
+        steps: List[models.UpdateStepRequest],
+        update_result_total_time: Optional[bool] = False,
+        replace_keywords: Optional[bool] = False,
+        replace_properties: Optional[bool] = False,
     ) -> models.UpdateStepsPartialSuccess:
         """Updates one or more steps.
 
@@ -262,6 +308,12 @@ def update_steps(
         Args:
             steps: a list of steps that are to be updated. Must include the global ID and
             each step being updated must match the version currently on the server.
+            update_result_total_time: Determine test result total time from the step total times.
+                Defaults to False.
+            replace_keywords: Replace with existing keywords instead of merging them.
+                Defaults to False.
+            replace_properties: Replace with existing properties instead of merging them.
+                Defaults to False.
 
         Returns
             A list of steps that were successfully updated and a list of ones that were not along
@@ -316,33 +368,6 @@ def get_step(self, result_id: str, step_id: str) -> models.Step:
         """
         ...
 
-    @delete(
-        "results/{resultId}/steps/{stepId}",
-        args=[Path("resultId"), Path("stepId"), Query("updateResultTotalTime")],
-    )
-    def delete_step(
-        self,
-        result_id: str,
-        step_id: str,
-        update_result_total_time: Optional[bool] = False,
-    ) -> None:
-        """Deletes a single step.
-
-        Args:
-            result_id: The resultId of the step to delete.
-            step_id: The stepId of the step to delete.
-            update_result_total_time: Determine test result total time from the step total times.
-                Defaults to False.
-
-        Returns:
-            None
-
-        Raises:
-            ApiException: if unable to communicate with the `/nitestmonitor` service or if there are
-            invalid arguments.
-        """
-        ...
-
     @returns.json  # type: ignore
     @post("query-step-values")
     def query_step_values(self, query: models.QueryStepValuesRequest) -> List[str]:

nisystemlink/clients/testmonitor/models/__init__.py

@@ -1,7 +1,9 @@
 from ._api_info import Operation, V2Operations, ApiInfo
+from ._named_value import NamedValue
 from ._result import Result
 from ._status import StatusType, Status
-from ._step import Step, NamedValue, StepData
+from ._step import Step
+from ._step_data import Measurement, StepData
 from ._paged_results import PagedResults
 from ._paged_steps import PagedSteps
 from ._delete_results_partial_success import DeleteResultsPartialSuccess
@@ -11,9 +13,9 @@
 from ._update_results_partial_success import UpdateResultsPartialSuccess
 from ._update_steps_partial_success import UpdateStepsPartialSuccess
 from ._create_result_request import CreateResultRequest
-from ._create_steps_request import CreateMultipleStepsRequest, CreateStepRequest
+from ._create_steps_request import CreateStepRequest
 from ._update_result_request import UpdateResultRequest
-from ._update_steps_request import UpdateMultipleStepsRequest, UpdateStepRequest
+from ._update_steps_request import UpdateStepRequest
 from ._query_results_request import (
     QueryResultsRequest,
     QueryResultValuesRequest,
@@ -26,7 +28,6 @@
     StepOrderBy,
     StepField,
     StepProjection,
-    StepResponseFormat,
 )
 
 # flake8: noqa

nisystemlink/clients/testmonitor/models/_create_steps_request.py

@@ -2,11 +2,9 @@
 from typing import Dict, List, Optional
 
 from nisystemlink.clients.core._uplink._json_model import JsonModel
-from nisystemlink.clients.testmonitor.models._step import (
-    NamedValue,
-    Status,
-    StepData,
-)
+from nisystemlink.clients.testmonitor.models._named_value import NamedValue
+from nisystemlink.clients.testmonitor.models._step import Status
+from nisystemlink.clients.testmonitor.models._step_data import StepData
 
 
 class BaseStepRequest(JsonModel):
@@ -56,11 +54,3 @@ class CreateStepRequest(BaseStepRequest):
 
     children: Optional[List["CreateStepRequest"]] = None
     """Nested child steps."""
-
-
-class CreateMultipleStepsRequest(JsonModel):
-    steps: List[CreateStepRequest]
-    """List of test steps to create."""
-
-    update_result_total_time: Optional[bool] = None
-    """Determine test result total time from the test step total times."""

nisystemlink/clients/testmonitor/models/_named_value.py

@@ -0,0 +1,11 @@
+from typing import Any
+
+from nisystemlink.clients.core._uplink._json_model import JsonModel
+
+
+class NamedValue(JsonModel):
+    name: str
+    """The name of the value."""
+
+    value: Any
+    """The value."""

nisystemlink/clients/testmonitor/models/_query_steps_request.py

@@ -2,6 +2,7 @@
 from typing import List, Optional
 
 from nisystemlink.clients.core._uplink._json_model import JsonModel
+from nisystemlink.clients.core._uplink._with_paging import WithPaging
 
 
 class StepOrderBy(str, Enum):
@@ -67,13 +68,6 @@ class StepProjection(str, Enum):
     PROPERTIES = "PROPERTIES"
 
 
-class StepResponseFormat(str, Enum):
-    """An enumeration of response formats for step queries."""
-
-    JSON = "JSON"
-    CSV = "CSV"
-
-
 class QueryStepsBase(JsonModel):
     filter: Optional[str] = None
     """The step query filter in Dynamic Linq format."""
@@ -89,7 +83,7 @@ class QueryStepsBase(JsonModel):
     """
 
 
-class QueryStepsRequest(QueryStepsBase):
+class QueryStepsRequest(QueryStepsBase, WithPaging):
     order_by: Optional[StepOrderBy] = None
     """Specifies the fields to use to sort the steps."""
 
@@ -99,15 +93,6 @@ class QueryStepsRequest(QueryStepsBase):
     take: Optional[int] = None
     """Maximum number of steps to return in the current API response."""
 
-    continuation_token: Optional[str] = None
-    """Allows users to continue the query at the next step that matches the given criteria.
-
-    To retrieve the next page of steps, pass the continuation token from the previous
-    page in the next request. The service responds with the next page of data and provides a new
-    continuation token. To paginate results, continue sending requests with the newest continuation
-    token provided in each response.
-    """
-
     return_count: Optional[bool] = None
     """If true, the response will include a count of all steps matching the filter.
 
@@ -129,12 +114,9 @@ class QueryStepsRequest(QueryStepsBase):
     all step fields will be returned.
     """
 
-    response_format: Optional[StepResponseFormat] = None
-    """Enum indicating the expected response format (CSV or JSON)."""
-
 
 class QueryStepValuesRequest(QueryStepsBase):
-    field: Optional[StepField] = None
+    field: StepField
     """The step field to return for this query."""
 
     starts_with: Optional[str] = None

nisystemlink/clients/testmonitor/models/_step.py

@@ -1,24 +1,10 @@
 from datetime import datetime
-from typing import Any, Dict, List, Optional
+from typing import Dict, List, Optional
 
 from nisystemlink.clients.core._uplink._json_model import JsonModel
+from nisystemlink.clients.testmonitor.models._named_value import NamedValue
 from nisystemlink.clients.testmonitor.models._status import Status
-
-
-class NamedValue(JsonModel):
-    name: str
-    """The name of the value."""
-
-    value: Any
-    """The value."""
-
-
-class StepData(JsonModel):
-    text: Optional[str] = None
-    """Text string describing the output data."""
-
-    parameters: Optional[List[dict[str, Optional[str]]]] = None
-    """List of properties objects."""
+from nisystemlink.clients.testmonitor.models._step_data import StepData
 
 
 class Step(JsonModel):