Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
e3ab7db3
Commit
e3ab7db3
authored
Apr 12, 2012
by
Michal Čihař
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Extend hooks documentation
parent
58c52801
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
30 additions
and
14 deletions
+30
-14
docs/admin.rst
docs/admin.rst
+2
-13
docs/api.rst
docs/api.rst
+28
-1
No files found.
docs/admin.rst
View file @
e3ab7db3
...
@@ -115,23 +115,12 @@ I case you will use SSH for pushing, you need to have key without passphrase
...
@@ -115,23 +115,12 @@ I case you will use SSH for pushing, you need to have key without passphrase
(or use ssh-agent for Django) and the remote server needs to be verified by you
(or use ssh-agent for Django) and the remote server needs to be verified by you
first, otherwise push will fail.
first, otherwise push will fail.
.. _hooks:
Interacting with others
Interacting with others
-----------------------
-----------------------
You can trigger update of underlaying git repository for every subproject or
Weblate makes it easy to interact with others using it's API.
project by accessing URL :file:`/hooks/update/project/subproject/` or
:file:`/hooks/update/project/`.
For GitHub, there is a special URL :file:`/hooks/github/`, which parses GitHub
notifications and updates related projects automatically.
.. note::
The GitHub notification relies on Git repository urls you use to be in form
.. seealso:: :ref:`api`
git://github.com/owner/repo.git, otherwise automatic detection of used
repository will fail.
.. _privileges:
.. _privileges:
...
...
docs/api.rst
View file @
e3ab7db3
.. _api:
Weblate's Web API
Weblate's Web API
=================
=================
.. _hooks:
Notification hooks
Notification hooks
------------------
------------------
Notification hooks allow external applications to notify weblate that Git
Notification hooks allow external applications to notify weblate that Git
repository has been updated.
repository has been updated.
.. describe:: GET /hooks/update/(string:project)/(string:subproject)/
Triggers update of a subproject (pulling from Git and scanning for
translation changes).
.. describe:: GET /hooks/update/(string:project)/
Triggers update of all subprojects in a project (pulling from Git and
scanning for translation changes).
.. describe:: POST /hooks/github/
Special hook for handling Github notifications and automatically updating
matching subprojects.
.. note::
The GitHub notification relies on Git repository urls you use to be in form
``git://github.com/owner/repo.git``, otherwise automatic detection of used
repository will fail.
.. seealso:: http://help.github.com/post-receive-hooks/
Exports
Exports
-------
-------
Weblate provides various exports to allow you further process the data.
Weblate provides various exports to allow you further process the data.
.. describe:: /exports/stats/(string:project)/(string:subproject)/
.. describe::
GET
/exports/stats/(string:project)/(string:subproject)/
Retrieves statistics for given subproject in JSON format.
Retrieves statistics for given subproject in JSON format.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment