summaryrefslogtreecommitdiffstats
path: root/docs/en
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2015-12-21 16:51:22 +0100
committerFrédéric Buclin <LpSolit@gmail.com>2015-12-21 16:51:22 +0100
commitc80aed6e1576b31a353c0e32d96f56952ed4b339 (patch)
tree9b4abc6ef598e26ae3e9bf3d6a39b2277329d571 /docs/en
parent107647545d204321c1125de25d577a669170c9a0 (diff)
downloadbugzilla-c80aed6e1576b31a353c0e32d96f56952ed4b339.tar.gz
bugzilla-c80aed6e1576b31a353c0e32d96f56952ed4b339.tar.xz
Bug 1234056: The "Create Comments" documentation incorrectly mentions that you can add a comment to several bugs at once
r=dkl
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/rst/api/core/v1/comment.rst5
1 files changed, 0 insertions, 5 deletions
diff --git a/docs/en/rst/api/core/v1/comment.rst b/docs/en/rst/api/core/v1/comment.rst
index 45c6fef25..0f7eef056 100644
--- a/docs/en/rst/api/core/v1/comment.rst
+++ b/docs/en/rst/api/core/v1/comment.rst
@@ -126,20 +126,15 @@ To create a comment on a current bug.
.. code-block:: js
{
- "ids" : [123,..],
"comment" : "This is an additional comment",
"is_private" : false,
"is_markdown" : true,
}
-``ids`` is optional in the data example above and can be used to specify adding
-a comment to more than one bug at the same time.
-
============ ======= ===========================================================
name type description
============ ======= ===========================================================
**id** int The ID or alias of the bug to append a comment to.
-ids array List of integer bug IDs to add the comment to.
**comment** string The comment to append to the bug. If this is empty
or all whitespace, an error will be thrown saying that you
did not set the ``comment`` parameter.