You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by br...@apache.org on 2015/02/24 15:43:11 UTC
[1/2] allura git commit: [#7829] add link from extending.rst to
WebhookSender class
Repository: allura
Updated Branches:
refs/heads/master 746ee514a -> 840e802c3
[#7829] add link from extending.rst to WebhookSender class
Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/840e802c
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/840e802c
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/840e802c
Branch: refs/heads/master
Commit: 840e802c3ebd093cc03ce42e65d53a9041a015dc
Parents: 784b8b4
Author: Dave Brondsema <da...@brondsema.net>
Authored: Tue Feb 24 09:42:57 2015 -0500
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Tue Feb 24 09:43:03 2015 -0500
----------------------------------------------------------------------
Allura/docs/extending.rst | 1 +
1 file changed, 1 insertion(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/840e802c/Allura/docs/extending.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/extending.rst b/Allura/docs/extending.rst
index 01218c3..825bcbd 100644
--- a/Allura/docs/extending.rst
+++ b/Allura/docs/extending.rst
@@ -40,6 +40,7 @@ The available extension points for Allura are:
* ``[allura.middleware]`` classes, which are standard WSGI middleware. They will receive the ``app`` instance and a ``config`` dict as constructor parameters.
The middleware will be used for all requests. By default the middleware wraps the base app directly and other middleware wrap around it.
If your middleware needs to wrap around the other Allura middleware (except error handling), set ``when = 'outer'`` on your middleware.
+* :class:`allura.webhooks.WebhookSender`
A listing of available 3rd-party extensions is at https://forge-allura.apache.org/p/allura/wiki/Extensions/
[2/2] allura git commit: [#7829] ticket:732 Add webhooks to API docs
Posted by br...@apache.org.
[#7829] ticket:732 Add webhooks to API docs
Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/784b8b42
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/784b8b42
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/784b8b42
Branch: refs/heads/master
Commit: 784b8b4208bf995ce4d0951b40e050161aeb6641
Parents: 746ee51
Author: Igor Bondarenko <je...@gmail.com>
Authored: Mon Feb 23 17:47:46 2015 +0200
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Tue Feb 24 09:43:03 2015 -0500
----------------------------------------------------------------------
Allura/allura/webhooks.py | 2 +-
Allura/docs/api/model/webhook.rst | 25 +++++++++++++++++++++++++
Allura/docs/api/webhooks.rst | 24 ++++++++++++++++++++++++
3 files changed, 50 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/784b8b42/Allura/allura/webhooks.py
----------------------------------------------------------------------
diff --git a/Allura/allura/webhooks.py b/Allura/allura/webhooks.py
index fc21bf4..fb37820 100644
--- a/Allura/allura/webhooks.py
+++ b/Allura/allura/webhooks.py
@@ -286,7 +286,7 @@ class WebhookSender(object):
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.
http://git-wip-us.apache.org/repos/asf/allura/blob/784b8b42/Allura/docs/api/model/webhook.rst
----------------------------------------------------------------------
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__
http://git-wip-us.apache.org/repos/asf/allura/blob/784b8b42/Allura/docs/api/webhooks.rst
----------------------------------------------------------------------
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: