[#7829] ticket:732 Add webhooks to API docs
diff --git a/Allura/allura/webhooks.py b/Allura/allura/webhooks.py
index ba55a89..102ae8b 100644
--- a/Allura/allura/webhooks.py
+++ b/Allura/allura/webhooks.py
@@ -287,7 +287,7 @@
def send(self, params_or_list):
"""Post a task that will send webhook payload
- :param:`params_or_list` - dict with keyword parameters to be passed to
+ :param params_or_list: dict with keyword parameters to be passed to
:meth:`get_payload` or a list of such dicts. If it's a list for each
element appropriate payload will be submitted, but limit will be
enforced only once for each webhook.
diff --git a/Allura/docs/api/model/webhook.rst b/Allura/docs/api/model/webhook.rst
new file mode 100644
index 0000000..b911b1a
--- /dev/null
+++ b/Allura/docs/api/model/webhook.rst
@@ -0,0 +1,25 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+:mod:`allura.model.webhook`
+-------------------------------------
+
+.. automodule:: allura.model.webhook
+
+ .. autoclass:: Webhook
+ :members:
+ :special-members: __json__
diff --git a/Allura/docs/api/webhooks.rst b/Allura/docs/api/webhooks.rst
new file mode 100644
index 0000000..d146ed6
--- /dev/null
+++ b/Allura/docs/api/webhooks.rst
@@ -0,0 +1,24 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _webhooks_module:
+
+:mod:`allura.webhooks`
+--------------------------------
+
+.. automodule:: allura.webhooks
+ :members:
