Mercurial > kraina_muminkow
comparison 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 |
comparison
equal
deleted
inserted
replaced
13:79cf8ca2a0e5 | 14:df32c1d01b8d |
---|---|
1 Porady dla osób korzystających z API | |
2 ==================================== | |
3 | |
4 Pobieranie informacji o zadaniu o danym ID | |
5 ------------------------------------------ | |
6 | |
7 Przy domyślnej konfiguracji pobranie danych o zadaniu o podanym ID wymaga | |
8 wykonania polecenia GET na elemencie pod adresem | |
9 ``/api/getjob/<apikey>/<ID>/``, gdzie: | |
10 | |
11 apikey | |
12 Klucz API taki, jak ustawiony w pliku config.ini | |
13 ID | |
14 Identyfikator zadania | |
15 | |
16 Serwer aplikacji powinien zwrócić dokument w formacie JSON zawierający | |
17 wszystkie dane znajdujące się w bazie, dotyczące tego zadania. | |
18 | |
19 Pobieranie informacji o wszystkich zadaniach | |
20 -------------------------------------------- | |
21 | |
22 ``/api/getjob/<apikey>/`` , gdzie *apikey* ma takie samo znaczenie jak | |
23 powyżej. | |
24 | |
25 Pobieranie jednego oczekującego zadania | |
26 --------------------------------------- | |
27 | |
28 ``/api/getnextjob/<apikey>/`` pobiera następne oczekujące działanie (wg numeru ID, | |
29 najpierw mniejsze wartości). *Ważne*: samo pobranie informacji **nie** zmienia | |
30 statusu zadania, trzeba to zrobić ręcznie za pomocą edycji zadania. | |
31 | |
32 Modyfikowanie danych zadania | |
33 ---------------------------- | |
34 | |
35 Należy wykonać *POST* na URI ``/api/modify/<apikey/<jobid>/``, gdzie: | |
36 | |
37 apikey | |
38 Klucz API z pliku config.ini | |
39 ID | |
40 Identyfikator zadania | |
41 | |
42 Natomiast jako dane POST należy przesłać nowe wartości, które chcemy wpisać do | |
43 bazy, przykładowo następująca linia poleceń programu CURL: | |
44 | |
45 curl --data "state=10&percent=40" localhost:5000/api/modify/apikey/1/ :: | |
46 | |
47 spowoduje ustawienie wartości ``state`` na 10 i ``percent`` na 40 przy zadaniu | |
48 o identyfikatorze ``1`. | |
49 | |
50 Funkcje wykorzystywane w API | |
51 ---------------------------- | |
52 | |
53 .. automodule:: mfrontend.views.api | |
54 :members: |