Bug | Mismatch between optional parameters in the proto definitions and the Python API

[sabarinathan-ni]

All the parameters in the python API documentation are marked optional whereas the proto file documentation clearly distinguishes between required and optional parameters.

Example: The API documentation for the TestResult object does not clearly state that the Name parameter is required and the other parameters are optional. This is clearly defined in the proto file.

Suggestions

1. In python documentation, the * can be moved after the list of required arguments.
2. Documentation can be updated to explicitly indicate the optional parameters as in the below image.

AB#3744858

[mjohanse-emr]

This fix also needs to be made for Step(). That constructor also does not reflect that name is required.