Confirmed users
1,927
edits
Bugzilla:BzAPI:Objects: Difference between revisions
Add deprecation notice
(Add internal links) |
(Add deprecation notice) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This page lists the objects used on 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 lists the objects used on the [[Bugzilla:BzAPI]], and the fields of each, along with their types, descriptions, and any names those fields may have in other contexts. | |||
====Notes==== | ====Notes==== | ||
| Line 24: | Line 30: | ||
|- | |- | ||
|attachments||Array of [[#Attachment|Attachment]]||Related files stored by Bugzilla||attachment | |attachments||Array of [[#Attachment|Attachment]]||Related files stored by Bugzilla||attachment | ||
|- | |- style="font-weight: bold" | ||
|blocks||Array of Integer||IDs of bugs which can only be fixed after this one||blocked | |blocks||Array of Integer||IDs of bugs which can only be fixed after this one (note: only returned by default in Bugzilla > 4.4 or BMO 4.2)||blocked | ||
|- | |- | ||
|cc||Array of [[#User|User]]||Users signed up to be notified of changes|| | |cc||Array of [[#User|User]]||Users signed up to be notified of changes|| | ||
| Line 40: | Line 46: | ||
|- style="font-weight: bold" | |- style="font-weight: bold" | ||
|deadline||Datestamp String||Date by which bug must be fixed|| | |deadline||Datestamp String||Date by which bug must be fixed|| | ||
|- | |- style="font-weight: bold" | ||
|depends_on||Array of Integer||Bugs that must be fixed first||dependson | |depends_on||Array of Integer||Bugs that must be fixed first (note: only returned by default in Bugzilla > 4.4 or BMO 4.2)||dependson | ||
|- | |- | ||
|dupe_of||Integer||Bug number of which this bug is a duplicate (only present if bug is RESOLVED DUPLICATE)|| | |dupe_of||Integer||Bug number of which this bug is a duplicate (only present if bug is RESOLVED DUPLICATE)|| | ||
| Line 145: | Line 151: | ||
|name||String, Read Only||Descriptive non-unique name for flag type, e.g. 'review'|| | |name||String, Read Only||Descriptive non-unique name for flag type, e.g. 'review'|| | ||
|- | |- | ||
|requestee|| | |requestee||[[#User|User]], Optional||User action is requested from, if flag is requestable; can only be set if setting status to '?'|| | ||
|- | |- | ||
|setter||[[#User|User]], Read Only||User who set the flag|| | |setter||[[#User|User]], Read Only||User who set the flag|| | ||
| Line 241: | Line 247: | ||
|- | |- | ||
|ref||String, Read Only||URL of user in API|| | |ref||String, Read Only||URL of user in API|| | ||
|} | |||
==Suggested Reviewer== | |||
{| border="1" | |||
!Name!!Type!!Description!!Other Names | |||
|- | |||
|email||String||Email address of user (if you are logged in)|| | |||
|- | |||
|id||Integer, Optional (for the moment)||Unique numeric identifier for user (currently only supplied on /user API)|| | |||
|- | |||
|name||String||User's real name|| | |||
|- | |||
|review_count||Integer||Number of reviews in this user's queue.|| | |||
|} | |} | ||