From fd850e00db835d2b84c59014c3b1021fea2294fc Mon Sep 17 00:00:00 2001 From: Israel Madueme Date: Fri, 10 Aug 2018 08:57:01 -0400 Subject: Bug 1456878 - Support markdown comments --- docs/en/rst/api/core/v1/comment.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/rst/api/core/v1/comment.rst b/docs/en/rst/api/core/v1/comment.rst index 2e6ca1e29..69508a364 100644 --- a/docs/en/rst/api/core/v1/comment.rst +++ b/docs/en/rst/api/core/v1/comment.rst @@ -98,10 +98,11 @@ creation_time datetime This is exactly same as the ``time`` key. Use this For compatibility, ``time`` is still usable. However, please note that ``time`` may be deprecated and removed in a future release. - is_private boolean ``true`` if this comment is private (only visible to a certain group called the "insidergroup"), ``false`` otherwise. +is_markdown boolean ``true`` if this comment is markdown. ``false`` if this + comment is plaintext. ============= ======== ======================================================== **Errors** @@ -123,7 +124,8 @@ it can also throw the following errors: Create Comments --------------- -This allows you to add a comment to a bug in Bugzilla. +This allows you to add a comment to a bug in Bugzilla. All comments created via the +API will be considered Markdown (specifically GitHub Flavored Markdown). **Request** -- cgit v1.2.3-24-g4f1b