Mercurial > kraina_muminkow
diff frontend/doc/api.txt @ 14:df32c1d01b8d
Dodałem edycję zadań przez POST, napisałem coś w rodzaju dokumentacji z nudów
author | Michał Rudowicz <michal.rudowicz@fl9.eu> |
---|---|
date | Fri, 01 Apr 2011 22:58:29 +0200 |
parents | |
children | 914d508e87c8 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/frontend/doc/api.txt Fri Apr 01 22:58:29 2011 +0200 @@ -0,0 +1,54 @@ +Porady dla osób korzystających z API +==================================== + +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 + +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 +powyżej. + +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. + +Modyfikowanie danych zadania +---------------------------- + +Należy wykonać *POST* na URI ``/api/modify/<apikey/<jobid>/``, gdzie: + +apikey + Klucz API z pliku config.ini +ID + Identyfikator zadania + +Natomiast jako dane POST należy przesłać nowe wartości, które chcemy wpisać do +bazy, przykładowo następująca linia poleceń programu CURL: + + curl --data "state=10&percent=40" localhost:5000/api/modify/apikey/1/ :: + +spowoduje ustawienie wartości ``state`` na 10 i ``percent`` na 40 przy zadaniu +o identyfikatorze ``1`. + +Funkcje wykorzystywane w API +---------------------------- + +.. automodule:: mfrontend.views.api + :members: