summaryrefslogtreecommitdiff
path: root/docs/gl_objects/messages.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-08-11 16:07:04 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-08-11 16:07:04 +0200
commit4057644f03829e4439ec8ab1feacf90c65d976eb (patch)
tree977658ba5109c8a3b512a882bf0a037daad754cb /docs/gl_objects/messages.rst
parent80eab7b0c0682c5df99495acc4d6f71f36603cfc (diff)
downloadgitlab-4057644f03829e4439ec8ab1feacf90c65d976eb.tar.gz
Update the objects doc/examples for v4
Diffstat (limited to 'docs/gl_objects/messages.rst')
-rw-r--r--docs/gl_objects/messages.rst18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/gl_objects/messages.rst b/docs/gl_objects/messages.rst
index 9f183ba..452370d 100644
--- a/docs/gl_objects/messages.rst
+++ b/docs/gl_objects/messages.rst
@@ -6,8 +6,22 @@ You can use broadcast messages to display information on all pages of the
gitlab web UI. You must have administration permissions to manipulate broadcast
messages.
-* Object class: :class:`gitlab.objects.BroadcastMessage`
-* Manager object: :attr:`gitlab.Gitlab.broadcastmessages`
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.BroadcastMessage`
+ + :class:`gitlab.v4.objects.BroadcastMessageManager`
+ + :attr:`gitlab.Gitlab.broadcastmessages`
+
+* v3 API:
+
+ + :class:`gitlab.v3.objects.BroadcastMessage`
+ + :class:`gitlab.v3.objects.BroadcastMessageManager`
+ + :attr:`gitlab.Gitlab.broadcastmessages`
+
+* GitLab API: https://docs.gitlab.com/ce/api/broadcast_messages.html
Examples
--------