Bugzilla:BzAPI: Difference between revisions

no edit summary
No edit summary
Line 13: Line 13:
Older pages in this wiki document released versions of BzAPI.
Older pages in this wiki document released versions of BzAPI.


===Version 0.4 (16th December 2009)===
===Version 0.5 (17th March 2010)===


'''Note: Versions up to and including 0.4.1 have a [https://bugzilla.mozilla.org/show_bug.cgi?id=552399 security issue] which could, under some circumstances, allow one user to impersonate another. If you are specifically using these versions (rather than the "latest" version) please update your client software to use version 0.5.'''
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=209064 Overview]
 
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=194234 API Methods]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=189987 Overview]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=189990 Parameters for the Search method]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=189985 API Methods]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=201806 Objects sent and received]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=185373 Parameters for the Search method]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects:Configuration&oldid=209065 The Configuration object]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=185369 Objects sent and received]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects:Configuration&oldid=185371 The Configuration object]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=185641 Tips, tricks and code samples]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=185641 Tips, tricks and code samples]


===Version 0.5 (17th March 2010)===
===Version 0.6 (14th April 2010)===


* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=209064 Overview]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=209064 Overview]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=194234 API Methods]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=215674 API Methods]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=189990 Parameters for the Search method]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=189990 Parameters for the Search method]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=201806 Objects sent and received]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=215678 Objects sent and received]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects:Configuration&oldid=209065 The Configuration object]
** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects:Configuration&oldid=209065 The Configuration object]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=185641 Tips, tricks and code samples]
* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=185641 Tips, tricks and code samples]
Line 39: Line 37:
Main Mozilla server (https://bugzilla.mozilla.org/):
Main Mozilla server (https://bugzilla.mozilla.org/):


  [https://api-dev.bugzilla.mozilla.org/0.5/ https://api-dev.bugzilla.mozilla.org/0.5/]
  [https://api-dev.bugzilla.mozilla.org/0.6/ https://api-dev.bugzilla.mozilla.org/0.6/]
  [https://api-dev.bugzilla.mozilla.org/latest/ https://api-dev.bugzilla.mozilla.org/latest/]
  [https://api-dev.bugzilla.mozilla.org/latest/ https://api-dev.bugzilla.mozilla.org/latest/]


Staging server (https://bugzilla-stage-tip.mozilla.org/):
Staging server (https://bugzilla-stage-tip.mozilla.org/):


  [https://api-dev.bugzilla.mozilla.org/stage/0.5/ https://api-dev.bugzilla.mozilla.org/stage/0.5/]
  [https://api-dev.bugzilla.mozilla.org/stage/0.6/ https://api-dev.bugzilla.mozilla.org/stage/0.6/]
  [https://api-dev.bugzilla.mozilla.org/stage/latest/ https://api-dev.bugzilla.mozilla.org/stage/latest/]
  [https://api-dev.bugzilla.mozilla.org/stage/latest/ https://api-dev.bugzilla.mozilla.org/stage/latest/]


Line 98: Line 96:
== Errors ==
== Errors ==


If methods are not successful for whatever reason, they will return an [[Bugzilla:REST_API:Objects#Error|Error]]. You should test every API return to see if it is an error ("error" member set to a true value).
If methods are not successful for whatever reason, they will return an [[Bugzilla:REST_API:Objects#Error|Error]]. ''You should test every API return to see if it is an error ("error" member set to a true value).''


The "code" field on an Error, if present, will give an error code from [[Bugzilla:WebServices:Errors|this list]]. The other member variables of the object are not stable, and should not be relied upon. The html_page, in particular, is only there so you can read it manually for a better idea of what the error was, and ask for the API to support it properly.
The "code" field on an Error, if present, will give an error code from [[Bugzilla:WebServices:Errors|this list]]. The other member variables of the object are not stable, and should not be relied upon. The html_page, in particular, is only there so you can read it manually for a better idea of what the error was, and ask for the API to support it properly.
Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti
4,925

edits