Bugzilla:BzAPI:Objects:Configuration: Difference between revisions
Jump to navigation
Jump to search
(Created page with 'This page gives details of the object returned by the Bugzilla:REST_API. ====Notes==== * The idea is that this object is designed for easy lookup of values, so there are a …') |
No edit summary |
||
Line 1: | Line 1: | ||
This page gives details of the object returned by the [[Bugzilla:REST_API]]. | This page gives details of the configuration object returned by the [[Bugzilla:REST_API]], and its sub-objects. | ||
====Notes==== | ====Notes==== |
Revision as of 15:24, 15 October 2009
This page gives details of the configuration object returned by the Bugzilla:REST_API, and its sub-objects.
Notes
- The idea is that this object is designed for easy lookup of values, so there are a lot of hashes, keyed by name or ID, instead of arrays over which one would have to iterate.
- The use of hashes also gives forwards-compatibility. For example, if some fields became product or component-specific, we could add a "fields" member to the hash.
Configuration
Name | Type | Notes |
---|---|---|
version | String | Bugzilla version |
maintainer | User | |
classifications | Hash of Classification, keyed by name | Only if useclassifications set |
products | Hash of Product, keyed by name | |
groups | Hash of Group, keyed by name | |
flag_type | Hash of FlagType, keyed by ID | |
field | Hash of Field, keyed by name |
Classification
Name | Type | Notes |
---|---|---|
id | Integer | |
product | Array of String | Product names |
Product
Name | Type | Notes |
---|---|---|
id | Integer | |
classification | String | Backreference because there is no nesting |
component | Hash of Component, indexed by name | |
version | Array of String | Version names |
target_milestone | Array of String | TM names |
group | Array of String | Group names |
Component
Name | Type | Notes |
---|---|---|
id | Integer | |
flag_type | Array of Integer | Flag type IDs |
Group
Name | Type | Notes |
---|---|---|
id | Integer | |
description | String | |
is_bug_group | Boolean | XXXname |
is_active | Boolean |
FlagType
Name | Type | Notes |
---|---|---|
name | String | |
description | String | |
is_bug | Boolean | XXXName |
is_requestable | Boolean | |
is_specifically_requestable | Boolean | |
is_multiplicable | Boolean | |
request_group | String | Group name |
grant_group | String | Group name |
Field
Name | Type | Notes |
---|---|---|
description | String | |
type | FieldType | |
is_on_bug_entry | Boolean | |
values | Array of String | Legal values for fields which have fixed set |
open | Array of String | 'status' field only - open statuses |
closed | Array of String | 'status' field only - closed statuses |
FieldType
Name | Type | Notes |
---|---|---|
id | Integer | |
description | String |