diff frontend/doc/api.txt @ 18:8dabb7e7f039

API zdefiniowane przez szablon
author Michał Rudowicz <michal.rudowicz@fl9.eu>
date Mon, 04 Apr 2011 10:44:09 +0200
parents c87f82a15606
children
line wrap: on
line diff
--- a/frontend/doc/api.txt	Sun Apr 03 14:07:19 2011 +0200
+++ b/frontend/doc/api.txt	Mon Apr 04 10:44:09 2011 +0200
@@ -1,36 +1,72 @@
 Porady dla osób korzystających z API
 ====================================
 
+Pobieranie informacji w formacie JSON
+-------------------------------------
+
 Pobieranie informacji o zadaniu o danym ID
-------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Przy domyślnej konfiguracji pobranie danych o zadaniu o podanym ID wymaga
 wykonania polecenia GET na elemencie pod adresem
-``/api/getjob/<apikey>/<ID>/``, gdzie:
-
-apikey
-    Klucz API taki, jak ustawiony w pliku config.ini
-ID
-    Identyfikator zadania
+``/api/getjob/<ID>/``, gdzie ID jest identyfikatorem zadania
 
 Serwer aplikacji powinien zwrócić dokument w formacie JSON zawierający
 wszystkie dane znajdujące się w bazie, dotyczące tego zadania.
 
 Pobieranie informacji o wszystkich zadaniach
---------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-``/api/getjob/<apikey>/`` , gdzie *apikey* ma takie samo znaczenie jak
+``/api/getjob/`` , gdzie *apikey* ma takie samo znaczenie jak
 powyżej.
 
+Pobieranie informacji w formacie zdefiniowanym przez szablon
+------------------------------------------------------------
+
+Klucz API
+^^^^^^^^^
+
+Klucz API, w URLach określany jako ``<apikey>``, jest kluczem pozwalającym na dostęp
+do informacji udostępnianych przez API i nie powinien być udostepniany nikomu poza
+osobami odpowiedzialnymi za aplikację rozproszoną korzystającą z serwera aplikacji.
+Klucz znajduje się w :ref:`config-ini`.
+
+Szablon pliku
+^^^^^^^^^^^^^
+
+Szablon pliku znajduje się w katalogu ``mfrontend/templates/joblist.csv`` i może być
+dowolnie dostosowywany według potrzeb serwera aplikacji.
+
+Domyślny szablon pliku:
+
+.. code-block:: jinja
+
+    {% for job in jobs %}
+    {{job.id}};{{job.hash}};{{job.method}};
+    {% endfor %}
+
+W razie potrzeby należy dodać kolejne pola w analogiczny sposób.
+
 Pobieranie jednego oczekującego zadania
----------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``/api/getnextjob/<apikey>/`` pobiera następne oczekujące działanie (wg numeru ID,
 najpierw mniejsze wartości). *Ważne*: samo pobranie informacji **nie** zmienia
 statusu zadania, trzeba to zrobić ręcznie za pomocą edycji zadania.
 
+Pobieranie informacji o zadaniu o danym ID
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Przy domyślnej konfiguracji pobranie danych o zadaniu o podanym ID wymaga
+wykonania polecenia GET na elemencie pod adresem
+``/api/getjob/<apikey>/<jobid>/``, gdzie ID jest identyfikatorem zadania
+
+Serwer aplikacji powinien zwrócić dokument w formacie zdefiniowanym przez szablon
+zawierający wszystkie dane znajdujące się w bazie dotyczące tego zadania.
+
+
 Modyfikowanie danych zadania
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Należy wykonać *POST* na URI ``/api/modify/<apikey/<jobid>/``, gdzie: