Skip to content
This repository was archived by the owner on Jul 21, 2021. It is now read-only.

documentation for getProduct and getProducts #35

Open
coyotebringsfire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

documentation for getProduct and getProducts #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,9 @@ retrieves a list of [suggested reviewers](https://wiki.mozilla.org/Bugzilla:BzAP
`getConfiguration(options, callback)`
gets the [configuration](https://wiki.mozilla.org/Bugzilla:REST_API:Objects:Configuration) of this Bugzilla server. Note: this only works currently against Mozilla's production instance, the bugzilla 5.0 instance running on landfill has no equivalent call that can be run from the browser due to a lack of CORS headers.

`getProducts(id)`
retrieves a list of all [products](https://bugs.cse.iitb.ac.in/bugs/docs/en/html/api/core/v1/product.html#get-product) matching the id. Valid values for id are `enterable`, `accessible`, `selectable`, a list of numeric product ids, or a list of product names. The method returns a promise that resolves when the response is available.

`getProduct(id)`
retrieves the [product](https://bugs.cse.iitb.ac.in/bugs/docs/en/html/api/core/v1/product.html#get-product) identified by id (either numeric product id, or product name). The method returns a promise that resolves when the response is available.