summaryrefslogtreecommitdiffstats
path: root/docs/en/rst
diff options
context:
space:
mode:
authorDavid Lawrence <dkl@mozilla.com>2015-05-11 16:36:15 +0200
committerDavid Lawrence <dkl@mozilla.com>2015-05-11 16:36:15 +0200
commitf805627ee9fcffba9f5a509bba652bfd663c6ae7 (patch)
tree9d2b335d577c461fd815b6bf90c035b17a4df3aa /docs/en/rst
parente4362dad68b2b9180de14d7683d7645e17206f53 (diff)
downloadbugzilla-f805627ee9fcffba9f5a509bba652bfd663c6ae7.tar.gz
bugzilla-f805627ee9fcffba9f5a509bba652bfd663c6ae7.tar.xz
Bug 1140575: Comment-creation WebService API should allow tags to be specified
r=glob,a=glob
Diffstat (limited to 'docs/en/rst')
-rw-r--r--docs/en/rst/api/core/v1/bug.rst4
-rw-r--r--docs/en/rst/api/core/v1/comment.rst35
2 files changed, 23 insertions, 16 deletions
diff --git a/docs/en/rst/api/core/v1/bug.rst b/docs/en/rst/api/core/v1/bug.rst
index 6b9be97cb..cdf6a80ac 100644
--- a/docs/en/rst/api/core/v1/bug.rst
+++ b/docs/en/rst/api/core/v1/bug.rst
@@ -593,6 +593,8 @@ assigned_to string A user to assign this bug to, if you don't want it
cc array An array of usernames to CC on this bug.
comment_is_private boolean If set to ``true``, the description is private,
otherwise it is assumed to be public.
+comment_tags array An array of strings to add as comment tags for the
+ description.
is_markdown boolean If set to ``true``, the description has Markdown
structures; otherwise it is normal text.
groups array An array of group names to put this bug into. You
@@ -780,6 +782,8 @@ comment_is_private object This is how you update the privacy of comments
updated. Thus, it is not practical to use this
while updating multiple bugs at once, as a single
comment ID will never be valid on multiple bugs.
+comment_tags array An array of strings to add as comment tags for
+ the new comment.
component string The Component the bug is in.
deadline date The Deadline field is a date specifying when the
bug must be completed by, in the format
diff --git a/docs/en/rst/api/core/v1/comment.rst b/docs/en/rst/api/core/v1/comment.rst
index 54048122a..45c6fef25 100644
--- a/docs/en/rst/api/core/v1/comment.rst
+++ b/docs/en/rst/api/core/v1/comment.rst
@@ -105,6 +105,7 @@ is_private boolean ``true`` if this comment is private (only visible to a
otherwise.
is_markdown boolean ``true`` if this comment needs Markdown processing;
``false`` otherwise.
+tags array An array of comment tags currently set for the comment.
============= ======== ========================================================
.. _rest_add_comment:
@@ -134,22 +135,24 @@ To create a comment on a current bug.
``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.
-is_private boolean If set to ``true``, the comment is private, otherwise it is
- assumed to be public.
-is_markdown boolean If set to ``true``, the comment has Markdown structures;
- otherwise it is normal text.
-work_time double Adds this many hours to the "Hours Worked" on the bug.
- If you are not in the time tracking group, this value will
- be ignored.
-=========== ======= ===========================================================
+============ ======= ===========================================================
+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.
+comment_tags array An array of strings to add as comment tags for the new
+ comment.
+is_private boolean If set to ``true``, the comment is private, otherwise it is
+ assumed to be public.
+is_markdown boolean If set to ``true``, the comment has Markdown structures;
+ otherwise it is normal text.
+work_time double Adds this many hours to the "Hours Worked" on the bug.
+ If you are not in the time tracking group, this value will
+ be ignored.
+============ ======= ===========================================================
**Response**