1302392 - Make best practices for Bugzilla API consumers more discoverable

Status: NEW

(bugzilla.mozilla.org :: Documentation, task)

Description

[Ed Morley [:emorley]]

Currently there is:
https://wiki.mozilla.org/BMO/Integration_Best_Practice

However it took several attempts to find it, since it wasn't linked from anywhere I looked, and a Google search for "bugzilla api best practices" didn't return it.

Perhaps we should move it to read the docs? ie somewhere under http://bugzilla.readthedocs.io/en/latest/api/ ?

In addition, we should:
* mention the speed issues even when using the BzAPI compatibility layer (if bug 1302390 hasn't updated it already)
* mention it being desirable to set a helpful user agent
* list which fields are indexed/more performant
* make recommendations for values for "limit" and/or also suggest the preferred way to paginate (I believe Dylan said something about limit/offset not being ideal?)
* mention using API keys not username/password
* mention listening to bug changes using pulse
* <add anything else missing>