Commit 7c519007 authored by Michal Čihař's avatar Michal Čihař

Document listing methods as well

Signed-off-by: default avatarMichal Čihař <michal@cihar.com>
parent 8345b649
...@@ -89,7 +89,15 @@ token, which you can get in your profile. Use it in the ``Authorization`` header ...@@ -89,7 +89,15 @@ token, which you can get in your profile. Use it in the ``Authorization`` header
Languages Languages
+++++++++ +++++++++
.. http:get:: /api/language/(string:language)/ .. http:get:: /api/languages/
Returns listing of all languages.
.. seealso::
Additional common headers, parameters and status codes are documented at :http:get:`/api/`.
.. http:get:: /api/languages/(string:language)/
Returns information about language. Returns information about language.
...@@ -103,6 +111,14 @@ Languages ...@@ -103,6 +111,14 @@ Languages
Projects Projects
++++++++ ++++++++
.. http:get:: /api/projects/
Returns listing of projects.
.. seealso::
Additional common headers, parameters and status codes are documented at :http:get:`/api/`.
.. http:get:: /api/projects/(string:project)/ .. http:get:: /api/projects/(string:project)/
Returns information about project. Returns information about project.
...@@ -152,9 +168,17 @@ Projects ...@@ -152,9 +168,17 @@ Projects
Components Components
++++++++++ ++++++++++
.. http:get:: /api/components/
Returns listin of translation components.
.. seealso::
Additional common headers, parameters and status codes are documented at :http:get:`/api/`.
.. http:get:: /api/components/(string:project)/(string:component)/ .. http:get:: /api/components/(string:project)/(string:component)/
Returns information about component. Returns information about translation component.
:param project: Project URL slug :param project: Project URL slug
:type project: string :type project: string
...@@ -263,6 +287,14 @@ Components ...@@ -263,6 +287,14 @@ Components
Translations Translations
++++++++++++ ++++++++++++
.. http:get:: /api/translations/
Returns list of translaions.
.. seealso::
Additional common headers, parameters and status codes are documented at :http:get:`/api/`.
.. http:get:: /api/translations/(string:project)/(string:component)/(string:language)/ .. http:get:: /api/translations/(string:project)/(string:component)/(string:language)/
Returns information about translation. Returns information about translation.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment