From 4fce480e9b1e1a67449cc476c9b400ba431071a8 Mon Sep 17 00:00:00 2001 From: Bystroushaak Date: Fri, 6 Nov 2015 19:06:08 +0100 Subject: [PATCH] #7: Added part of the documentation of the REST url's. --- .../amqp/rest/html_templates/index.html | 91 ++++++++++++++++++- 1 file changed, 87 insertions(+), 4 deletions(-) diff --git a/src/edeposit/amqp/rest/html_templates/index.html b/src/edeposit/amqp/rest/html_templates/index.html index d240a7e..daedfa7 100644 --- a/src/edeposit/amqp/rest/html_templates/index.html +++ b/src/edeposit/amqp/rest/html_templates/index.html @@ -7,13 +7,96 @@ - REST API -++++++++ +======== + +Vítejte v dokumentaci REST API projektu e-deposit. Toto API vám umožňuje ohlašovat publikace automatickým způsobem. Dále také umožňuje sledovat stav publikací tak, jak postupně procházejí různými odděleními knihovny. + +Přihlášení +---------- + +API vyžaduje přihlášení uživatelským jménem metodou HTML Basic AUTH přes SSL. + +Uživatelské jméno a heslo je rozdílné od jména určeného pro přihlášení do samotného e-edepositu a je nutné ho vygenerovat ve vašem účtu. + +Adresy API +---------- + +Všechny adresy začínají prefixem ``/api/v1/``, který byl pro zjednodušení vypušten. Je-li uvedeno, že se jedná o adresu ``/submit``, je ve skutečnosti myšlena plná cesta, tedy ``/api/v1/submit``. + +Seznam adres jednotlivých bodů REST API: + ++---------------+----------------------+-------------+-----------------------------------------------------+ +| Typ požadavku | URL | Parametry | Popis | ++===============+======================+=============+=====================================================+ +| POST | ``/submit`` | Viz detaily | Odeslat nový požadavek. | ++---------------+----------------------+-------------+-----------------------------------------------------+ +| GET | ``/track`` | Ne | Zjisit stav všech ohlášených požadavků. | ++---------------+----------------------+-------------+-----------------------------------------------------+ +| GET | ``/track/`` | Ne | Zjistit stav požadavku s identifikátorem `rest_id`. | ++---------------+----------------------+-------------+-----------------------------------------------------+ + +/submit ++++++++ + +Ohlášení nové e-publikace a souvisejících metadat. + +Vyžadované parametry +^^^^^^^^^^^^^^^^^^^^ + ++--------------------------+----------------+ +| Jméno parametru | Popis | ++==========================+================+ +| ``nazev`` | Název e-knihy. | ++--------------------------+----------------+ +| ``poradi_vydani`` | | ++--------------------------+----------------+ +| ``misto_vydani`` | | ++--------------------------+----------------+ +| ``rok_vydani`` | | ++--------------------------+----------------+ +| ``nakladatel_vydavatel`` | | ++--------------------------+----------------+ +| ``zpracovatel_zaznamu`` | | ++--------------------------+----------------+ + +Volitelné parametry +^^^^^^^^^^^^^^^^^^^ + ++------------------------+-----------------+ +| Jméno parametru | Popis | ++========================+=================+ +| podnazev | Podnázev knihy. | ++------------------------+-----------------+ +| cast | | ++------------------------+-----------------+ +| nazev_casti | | ++------------------------+-----------------+ +| isbn | | ++------------------------+-----------------+ +| generated_isbn | | ++------------------------+-----------------+ +| isbn_souboru_publikaci | | ++------------------------+-----------------+ +| author1 | | ++------------------------+-----------------+ +| author2 | | ++------------------------+-----------------+ +| author3 | | ++------------------------+-----------------+ +| vydano_v_koedici_s | | ++------------------------+-----------------+ +| cena | | ++------------------------+-----------------+ + +/track +++++++ + + +/track/ +++++++++++++++++ -Seznam *adres* jednotlivých bodů REST API: - - something..