diff options
| author | Israel Madueme <purelogiq@gmail.com> | 2018-08-10 14:57:01 +0200 |
|---|---|---|
| committer | Dylan William Hardison <dylan@hardison.net> | 2018-08-10 14:57:01 +0200 |
| commit | fd850e00db835d2b84c59014c3b1021fea2294fc (patch) | |
| tree | b5529f9bf45bb2b8f66b19714d215f1ca6c06c94 /docs | |
| parent | 5a43b27f7940be9697f312c550fa2de11a9e14d7 (diff) | |
| download | bugzilla-fd850e00db835d2b84c59014c3b1021fea2294fc.tar.gz bugzilla-fd850e00db835d2b84c59014c3b1021fea2294fc.tar.xz | |
Bug 1456878 - Support markdown comments
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/rst/api/core/v1/comment.rst | 6 |
1 files changed, 4 insertions, 2 deletions
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** |