Bug 802138

Summary:	BZ: Bug.update does not work as documented for summary updates
Product:	[Community] Bugzilla	Reporter:	Tomas Hoger <thoger>
Component:	WebService	Assignee:	PnT DevOps Devs <hss-ied-bugs>
Status:	CLOSED WONTFIX	QA Contact:
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	3.6	CC:	sgreen
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-03-14 01:18:20 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Tomas Hoger 2012-03-11 16:40:03 UTC

Description of problem:
Following xmlrpc interface documentation for Bug.update:

  https://bugzilla.redhat.com/docs/en/html/api/Bugzilla/WebService/Bug.html

says:

  short_desc|summary (string) - New bug summary.

This suggests that either 'short_desc' or 'summary' can be used as a key in the updates hash passed to the api.  However, only 'short_desc' works and no change is made when 'summary' is used instead.

Comment 1 Simon Green 2012-03-14 01:18:20 UTC

Definitely a bug, but it won't be fixed. We will inherit Mozilla's Bug.update when we release 4.2, and their documentation on this too.

  -- simon

Comment 2 Tomas Hoger 2012-03-14 08:11:42 UTC

AFAICS, upstream documentation says 'summary' should work.

http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html

Keeping 'short_desc' working and not 'summary' does not seem to help write code that does not break after we go to 4.x.

Can our documentation be corrected, possibly with warning that is going to break with 4.x?

Comment 3 Simon Green 2012-03-27 11:58:19 UTC

(In reply to comment #2)
> Can our documentation be corrected, possibly with warning that is going to
> break with 4.x?

No. Bugzilla 3.6 is now in maintenance mode. Only security fixes or major bugs will be fixed in future releases.

  -- simon