BMO/Integration Best Practice: Difference between revisions

no edit summary
No edit summary
Line 10: Line 10:
** Search results generally return a bug's last-modified date; there's no need to re-request the bug if it hasn't been modified since the last time you saw it
** Search results generally return a bug's last-modified date; there's no need to re-request the bug if it hasn't been modified since the last time you saw it
* '''Only request the fields that you are interested in'''
* '''Only request the fields that you are interested in'''
** By default all the BzAPI APIs except the search API will return all fields. As most systems only use a few fields, you should use ''include_fields'' ([https://wiki.mozilla.org/Bugzilla:REST_API#Field_Control BzAPI docs])
** By default all APIs return more information than you probably require - use the ''include_fields'' parameter to specify the exact fields you need ([https://wiki.mozilla.org/Bugzilla:REST_API#Field_Control BzAPI])([http://www.bugzilla.org/docs/4.0/en/html/api/Bugzilla/WebService.html#Limiting_What_Fields_Are_Returned XMLRPC/JSONRPC])
** When searching with BzAPI, avoid specifying [https://wiki.mozilla.org/Bugzilla:REST_API:Objects#Bug non-bold columns] if you can avoid it, because it'll be slower and user server-side resources
* '''Coalesce queries where possible'''
* '''Coalesce queries where possible'''
** If you have multiple bugs, components, etc to query, it can be more efficient issue a single request rather than iterating over your list and issuing multiple requests
** If you have multiple bugs, components, etc to query, it can be more efficient issue a single request rather than iterating over your list and issuing multiple requests
Confirmed users
1,201

edits