Hide Forgot
Description of problem: Please expose an option to set comments when creating new TestCaseRun using nitrate xmlrpc. Currently it's possible to set notes only.
TestCaseRun could be created via WebUI, and there's no options for setting comments via WebUI. We didn't expose 'adding comments' while create new tcr using rpc to ensure the consistency. If you need to set comment for TestCaseRun, there's TestCaseRun.add_comment(https://tcms.engineering.redhat.com/xmlrpc/#testcaserun.add_comment) Comments could be added after TestCaseRun is created. What's your opinion for this?
(In reply to comment #1) > TestCaseRun could be created via WebUI, and there's no options for setting > comments via WebUI. > We didn't expose 'adding comments' while create new tcr using rpc to ensure the > consistency. > > If you need to set comment for TestCaseRun, there's > TestCaseRun.add_comment(https://tcms.engineering.redhat.com/xmlrpc/#testcaserun.add_comment) > > Comments could be added after TestCaseRun is created. > > What's your opinion for this? Consistency is good and I can live with your solution, but generally APIs provide more flexible and powerful way to operate application so IMHO TestCaseRun.create verb may have such parameter 'comments' instead of calling an additional verb after that.
> APIs > provide more flexible and powerful way to operate application Indeed. Will fix it in 3.5
In designing API, keeping API atomic is more preferred. It allows us to keep the API more consistent which is very important for all users. Plus, comment of a TestCase is not a natural attribute of itself, it is semantically confusing to add comment in TestCaseRun.create() call. This hence will not be resolved.