Add support for broadcast messages API

1 files changed, 46 insertions, 0 deletions

diff --git a/docs/gl_objects/messages.rst b/docs/gl_objects/messages.rst
new file mode 100644
index 0000000..9f183ba
--- /dev/null
+++ b/docs/gl_objects/messages.rst
@@ -0,0 +1,46 @@
+##################
+Broadcast messages
+##################
+
+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`
+
+Examples
+--------
+
+List the messages:
+
+.. literalinclude:: messages.py
+   :start-after: # list
+   :end-before: # end list
+
+Get a single message:
+
+.. literalinclude:: messages.py
+   :start-after: # get
+   :end-before: # end get
+
+Create a message:
+
+.. literalinclude:: messages.py
+   :start-after: # create
+   :end-before: # end create
+
+The date format for ``starts_at`` and ``ends_at`` parameters is
+``YYYY-MM-ddThh:mm:ssZ``.
+
+Update a message:
+
+.. literalinclude:: messages.py
+   :start-after: # update
+   :end-before: # end update
+
+Delete a message:
+
+.. literalinclude:: messages.py
+   :start-after: # delete
+   :end-before: # end delete