Confirmed users
1,927
edits
Bugzilla:BzAPI:Objects:Configuration: Difference between revisions
Bugzilla:BzAPI:Objects:Configuration (view source)
Revision as of 02:06, 21 September 2016
, 21 September 2016Add deprecation notice
No edit summary |
(Add deprecation notice) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This page gives details of the configuration object returned by the [[Bugzilla: | <div style="border: thin dotted #aaa; padding:5px;"> | ||
'''This specific REST API, generally referred to as "BzAPI", is DEPRECATED. For new projects, use the [[Bugzilla:REST_API|native REST API]] instead. The BMO team has implemented a [[Bugzilla:BzAPI:CompatLayer|compatibility layer]] to help existing apps transition off BzAPI onto the native REST API. Please migrate existing BzAPI-based apps to the new compatibility-layer endpoint as soon as possible, as BzAPI will be shut off at some point in the future. Direct any questions to the [[BMO]] team. | |||
'''The native REST API is available in Bugzilla 5.0 and up, and on bugzilla.mozilla.org. Although BzAPI is deprecated, it can be used with older Bugzilla installations (versions prior to 5.0) to provide a REST API.''' | |||
</div><br> | |||
This page gives details of the configuration object returned by the [[Bugzilla:BzAPI]], and its sub-objects. | |||
====Notes==== | ====Notes==== | ||
| Line 21: | Line 27: | ||
|version||String||Bugzilla version | |version||String||Bugzilla version | ||
|- | |- | ||
|maintainer||[[Bugzilla: | |maintainer||[[Bugzilla:BzAPI:Objects#User|User]]|| | ||
|- | |- | ||
|announcement||String||HTML; something the Bugzilla admin wants users to know | |announcement||String||HTML; something the Bugzilla admin wants users to know | ||
| Line 27: | Line 33: | ||
|max_attachment_size||Integer||In bytes; useful so clients can prevent large uploads which will fail | |max_attachment_size||Integer||In bytes; useful so clients can prevent large uploads which will fail | ||
|- | |- | ||
|classification||Hash of [[Bugzilla: | |classification||Hash of [[Bugzilla:BzAPI:Objects:Configuration#Classification|Classification]], keyed by name||Only if useclassifications set | ||
|- | |- | ||
|product||Hash of [[Bugzilla: | |product||Hash of [[Bugzilla:BzAPI:Objects:Configuration#Product|Product]], keyed by name|| | ||
|- | |- | ||
|group||Hash of [[Bugzilla: | |group||Hash of [[Bugzilla:BzAPI:Objects:Configuration#Group|Group]], keyed by name|| | ||
|- | |- | ||
|flag_type||Hash of [[Bugzilla: | |flag_type||Hash of [[Bugzilla:BzAPI:Objects:Configuration#FlagType|FlagType]], keyed by ID|| | ||
|- | |- | ||
|field||Hash of [[Bugzilla: | |field||Hash of [[Bugzilla:BzAPI:Objects:Configuration#Field|Field]], keyed by name|| | ||
|} | |} | ||
| Line 44: | Line 50: | ||
|- | |- | ||
|id||Integer|| | |id||Integer|| | ||
|- | |||
|description||String||Textual description | |||
|- | |- | ||
|product||Array of String||Product names | |product||Array of String||Product names | ||
| Line 54: | Line 62: | ||
|- | |- | ||
|id||Integer|| | |id||Integer|| | ||
|- | |||
|description||String||Textual description | |||
|- | |||
|is_active||Boolean||Whether product is accepting new bugs and appears on normal lists of products | |||
|- | |||
|is_permitting_unconfirmed||Boolean||Whether product accepts submission of UNCONFIRMED bugs or allows bugs to be switched to that state | |||
|- | |- | ||
|classification||String||Backreference because there is no nesting; only if useclassifications set | |classification||String||Backreference because there is no nesting; only if useclassifications set | ||
|- | |- | ||
|component||Hash of [[Bugzilla: | |component||Hash of [[Bugzilla:BzAPI:Objects:Configuration#Component|Component]], indexed by name|| | ||
|- | |- | ||
|version||Array of String||Version names | |version||Array of String||Version names | ||
|- | |- | ||
|target_milestone||Array of String||TM names; only if usetargetmilestone set | |target_milestone||Array of String||TM names; only if usetargetmilestone set | ||
|- | |||
|default_target_milestone||String||Default value for milestone field; only if usetargetmilestone set | |||
|- | |- | ||
|group||Array of String||Names of groups settable on bugs in this product | |group||Array of String||Names of groups settable on bugs in this product | ||
| Line 72: | Line 88: | ||
|- | |- | ||
|id||Integer|| | |id||Integer|| | ||
|- | |||
|description||String||Textual description | |||
|- | |- | ||
|flag_type||Array of Integer||IDs of flag types settable on bugs/attachments in this component | |flag_type||Array of Integer||IDs of flag types settable on bugs/attachments in this component | ||
| Line 118: | Line 136: | ||
|- | |- | ||
|description||String|| | |description||String|| | ||
|- | |||
|is_active||Boolean||Whether field is currently used or not | |||
|- | |- | ||
|type||Integer, Enumeration||FIELD_TYPE_* constants from Constants.pm; 0 means "unknown" | |type||Integer, Enumeration||FIELD_TYPE_* constants from Constants.pm; 0 means "unknown" | ||