Description of problem: BZ provides following setting in user preferences: Set the private comment checkbox by default for new comments (Default: off) The name does not hint it, but it does affect XMLRPC too. When using Bug.create and no comment_is_private is provided with the request, the value of that setting is used to determine whether comment 0 is made public or private. This is inconsistent with the documentation: https://bugzilla.redhat.com/docs/en/html/api/Bugzilla/WebService/Bug.html#create comment_is_private (boolean) - If set to true, the description is private, otherwise it is assumed to be public. Additionally, this is also inconsistent across various API calls. When using Bug.update with: 'comment' => { 'body' => 'comment text' }, with no is_private value provided, new comment is added as public even when the option is set to On.
Note that this does not seem to be new problem in BZ 4.2, as it seems bug creation was affected by this setting before.
The correct behaviour is for comments to be created as private if no is_private value is provided, and the user has that option selected. Therefore we need to make three changes: 1) Update the text of the option to 'Make new comments private by default', thus clarifying the option to the users 2) Update the RPC documentation to reflect this. The documentation comes from upstream, which does not have this option. 3) Go through all the Bug.* RPC calls, and make sure that they honour the users setting for this option. Hotfix reason: Inconsistency between documentation and functionality. Not what a user would expect.
Documentation isn't urgent and should be fixed in a minor release.
Changes committed in code, as part of the Bugzilla 4.2.1-3 release. (In reply to comment #2) > 1) Update the text of the option to 'Make new comments private by default', > thus clarifying the option to the users Done. > 2) Update the RPC documentation to reflect this. The documentation comes > from upstream, which does not have this option. Done. > 3) Go through all the Bug.* RPC calls, and make sure that they honour the > users setting for this option. The calls that honour this value are: Bug.create Bug.update Bug.add_comment Bug.add_attachment The RedHat.* and bugzilla.* calls won't be updated, as these will be depreciated one day. -- simon
This change is due to go live at 9pm UTC today (Monday July 9th) -- simon
The release date has been changed to 9pm UTC this Thursday (July 12th). Sorry for any inconvenience this late change may cause. -- simon
This comment was flagged a spam, view the edit history to see the original text if required.