summaryrefslogtreecommitdiffstats
path: root/docs/en/rst/api/core/v1/product.rst
diff options
context:
space:
mode:
authorDavid Lawrence <dkl@mozilla.com>2016-02-23 23:06:55 +0100
committerDavid Lawrence <dkl@mozilla.com>2016-02-23 23:06:55 +0100
commit89852803b2c696c62e79372e9dc36331cd728156 (patch)
treebfba5830e08c192c11239df990bdcd8eda6cfe88 /docs/en/rst/api/core/v1/product.rst
parent14832008c5fb813a86a6b2b78baa50d068675dd9 (diff)
downloadbugzilla-89852803b2c696c62e79372e9dc36331cd728156.tar.gz
bugzilla-89852803b2c696c62e79372e9dc36331cd728156.tar.xz
Bug 1244718 - API documentation is missing error codes
Diffstat (limited to 'docs/en/rst/api/core/v1/product.rst')
-rw-r--r--docs/en/rst/api/core/v1/product.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/en/rst/api/core/v1/product.rst b/docs/en/rst/api/core/v1/product.rst
index 95726a3a8..4819bbbbe 100644
--- a/docs/en/rst/api/core/v1/product.rst
+++ b/docs/en/rst/api/core/v1/product.rst
@@ -320,6 +320,23 @@ name type description
id int ID of the newly-filed product.
==== ==== =====================================
+**Errors**
+
+* 51 (Classification does not exist)
+ You must specify an existing classification name.
+* 700 (Product blank name)
+ You must specify a non-blank name for this product.
+* 701 (Product name too long)
+ The name specified for this product was longer than the maximum
+ allowed length.
+* 702 (Product name already exists)
+ You specified the name of a product that already exists.
+ (Product names must be globally unique in Bugzilla.)
+* 703 (Product must have description)
+ You must specify a description for this product.
+* 704 (Product must have version)
+ You must specify a version for this product.
+
.. _rest_product_update:
Update Product
@@ -414,3 +431,18 @@ changes object The changes that were actually done on this product. The
Booleans will be represented with the strings '1' and '0' for changed values
as they are stored as strings in the database currently.
+
+**Errors**
+
+* 700 (Product blank name)
+ You must specify a non-blank name for this product.
+* 701 (Product name too long)
+ The name specified for this product was longer than the maximum
+ allowed length.
+* 702 (Product name already exists)
+ You specified the name of a product that already exists.
+ (Product names must be globally unique in Bugzilla.)
+* 703 (Product must have description)
+ You must specify a description for this product.
+* 705 (Product must define a default milestone)
+ You must define a default milestone.