<commit_before><HTML>
<head>
    <title>REST API systému Edeposit</title>
    <!-- <link rel="stylesheet" type="text/css" href="style.css"> -->
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>

<rst>
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.

.. _HTML Basic AUTH: https://cs.wikipedia.org/wiki/Basic_access_authentication

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``          | ``data``, viz detaily | Odeslat nový požadavek ohlášení knihy.                          |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+
| GET           | ``/track``           | Ne                    | Zjisit stav všech ohlášených požadavků.                         |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+
| GET           | ``/track/<rest_id>`` | Ne                    | Zjistit stav konkrétního požadavku s identifikátorem `rest_id`. |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+

/submit
+++++++

Ohlášení nové e-publikace a souvisejících metadat. Tento krok odstraňuje nutnost ruční práce uživatele, který by jinak ohlášení musel provést manuálně přes webové rozhraní.

Vzhledem k nutnosti odeslat v jednom kroku jednak samotný soubor, ale i strukturovaná metadata bylo rozhodnuto pro odeslání dat jako JSON strukturu 

Vyžadované parametry
^^^^^^^^^^^^^^^^^^^^

+--------------------------+-----------------------------------------------------+
|     Jméno parametru      |                        Popis                        |
+==========================+=====================================================+
| ``nazev``                | Název e-knihy.                                      |
+--------------------------+-----------------------------------------------------+
| ``poradi_vydani``        | Pořadí, ve kterém byla kniha vydána.                |
+--------------------------+-----------------------------------------------------+
| ``misto_vydani``         | Místo vydání s přesností na město.                  |
+--------------------------+-----------------------------------------------------+
| ``rok_vydani``           | Rok ve kterém byla kniha vydána.                    |
+--------------------------+-----------------------------------------------------+
| ``nakladatel_vydavatel`` | Název nakladatele či vydavatele knihy.              |
+--------------------------+-----------------------------------------------------+
| ``zpracovatel_zaznamu``  | Jméno osoby zodopovědné za odeslání tohoto záznamu. |
+--------------------------+-----------------------------------------------------+
| ``nazev_souboru``        | Název nahrávaného souboru.                          |
+--------------------------+-----------------------------------------------------+

Volitelné parametry
^^^^^^^^^^^^^^^^^^^

+----------------------------+--------------------------------------------------------------------------+
|      Jméno parametru       |                                  Popis                                   |
+============================+==========================================================================+
| ``podnazev``               | Podnázev knihy.                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``cast``                   |                                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``nazev_casti``            |                                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``isbn``                   | ISBN které má být použité pro knihu. Pokud není uvedeno, bude přiděleno. |
+----------------------------+--------------------------------------------------------------------------+
| ``isbn_souboru_publikaci`` | ISBN souboru publikací.                                                  |
+----------------------------+--------------------------------------------------------------------------+
| ``author1``                | Autor knihy.                                                             |
+----------------------------+--------------------------------------------------------------------------+
| ``author2``                | Další autor knihy.                                                       |
+----------------------------+--------------------------------------------------------------------------+
| ``author3``                | Možnost uvést třetího autora knihy.                                      |
+----------------------------+--------------------------------------------------------------------------+
| ``vydano_v_koedici_s``     | Vydáno v koedici s .. (jméno vydavatele).                                |
+----------------------------+--------------------------------------------------------------------------+
| ``cena``                   | Cena knihy v korunách.                                                   |
+----------------------------+--------------------------------------------------------------------------+
| ``zpristupnení``           | Zpřístupnění knihy dalším knihovnám. Hodnoty viz tabulka dále.           |
+----------------------------+--------------------------------------------------------------------------+
| ``riv``                    | Kategorie RIVu.                                                          |
+----------------------------+--------------------------------------------------------------------------+

Zpřístupnění
````````````

Je možné nastavit volitelné zpřístupnění e-publikace různým knihovnám. Ze smlouvy plyne, že kniha je vždy zpřístupněna minimálně Národní knihovně České republiky.

+-------------------------------------------------------+----------------------------------------------------+
|                      Hodnota pole                     |                    Význam pole                     |
+=======================================================+====================================================+
| ``moravska-zemska-knihovna-v-brne``                   | Moravská zemská knihovna v Brně.                   |
+-------------------------------------------------------+----------------------------------------------------+
| ``vedecka-knihovna-v-olomouci``                       | Vědecká knihovna v Olomouci.                       |
+-------------------------------------------------------+----------------------------------------------------+
| ``jihoceska-vedecka-knihovna-v-ceskych-budejovicich`` | Jihočeská vědecká knihovna v Českých Budějovicích. |
+-------------------------------------------------------+----------------------------------------------------+
| ``studijni-a-vedecka-knihovna-v-hradci-kralove``      | Studijní a vědecká knihovna v Hradci Králové.      |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-karlovy-vary``                     | Krajská knihovna Karlovy Vary.                     |
+-------------------------------------------------------+----------------------------------------------------+
| ``stredoceska-vedecka-knihovna-v-kladne``             | Středočeská vědecká knihovna v Kladně.             |
+-------------------------------------------------------+----------------------------------------------------+
| ``moravskoslezska-vedecka-knihovna-v-ostrave``        | Moravskoslezská vědecká knihovna v Ostravě.        |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-vedecka-knihovna-v-liberci``                | Krajská vědecká knihovna v Liberci.                |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-v-pardubicich``                    | Krajská knihovna v Pardubicích.                    |
+-------------------------------------------------------+----------------------------------------------------+
| ``studijni-a-vedecka-knihovna-plzenskeho-kraje``      | Studijní a vědecká knihovna Plzeňského kraje.      |
+-------------------------------------------------------+----------------------------------------------------+
| ``mestska-knihovna-v-praze``                          | Městská knihovna v Praze.                          |
+-------------------------------------------------------+----------------------------------------------------+
| ``severoceska-vedecka-knihovna-v-usti-nad-labem``     | Severočeská vědecká knihovna v Ústí nad Labem.     |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-vysociny-havlickuv-brod``          | Krajská knihovna Vysočiny (Havlíčkův Brod).        |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-frantiska-bartose-ve-zline``       | Krajská knihovna Františka Bartoše ve Zlíně.       |
+-------------------------------------------------------+----------------------------------------------------+

RIV
```

Dále je možné vybrat kategorii pro RIV.

+--------------+-----------------------------------------------------------------------+
| Č. kategorie |                                 Význam                                |
+==============+=======================================================================+
|            1 | Společenské, humanitní a umělecké vědy (SHVa)                         |
+--------------+-----------------------------------------------------------------------+
|            2 | Společenské vědy (SHVb)                                               |
+--------------+-----------------------------------------------------------------------+
|            3 | Společenské vědy (SHVc)                                               |
+--------------+-----------------------------------------------------------------------+
|            4 | Technické a informatické vědy                                         |
+--------------+-----------------------------------------------------------------------+
|            5 | Zemědělské vědy (rostlinná výroba, živočišná výroba a potravinářství) |
+--------------+-----------------------------------------------------------------------+
|            6 | Vědy o Zemi                                                           |
+--------------+-----------------------------------------------------------------------+
|            7 | Matematické vědy                                                      |
+--------------+-----------------------------------------------------------------------+
|            8 | Fyzikální vědy (pouze pilíř II.)                                      |
+--------------+-----------------------------------------------------------------------+
|            9 | Chemické vědy (pouze pilíř II.)                                       |
+--------------+-----------------------------------------------------------------------+
|           10 | Biologické vědy (pouze pilíř II.)                                     |
+--------------+-----------------------------------------------------------------------+
|           11 | Lékařské vědy (pouze pilíř II.)                                       |
+--------------+-----------------------------------------------------------------------+

Návratová hodnota
^^^^^^^^^^^^^^^^^

Návratovou hodnotou volání url ``/submit`` je `rest_id`, unikátní identifikátor právě ohlášeného požadavku ve formátu `UUID`_. Tento identifikátor lze dále použít pro sledování průběhu ohlašování.

.. _UUID: https://en.wikipedia.org/wiki/Universally_unique_identifier


/track
++++++


/track/<rest_id>
++++++++++++++++



</rst>

</body>
</HTML>
<commit_msg>#7: Tables fixed according to edeposit/edeposit.amqp.models.<commit_after><HTML>
<head>
    <title>REST API systému Edeposit</title>
    <!-- <link rel="stylesheet" type="text/css" href="style.css"> -->
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>

<rst>
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.

.. _HTML Basic AUTH: https://cs.wikipedia.org/wiki/Basic_access_authentication

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``          | ``data``, viz detaily | Odeslat nový požadavek ohlášení knihy.                          |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+
| GET           | ``/track``           | Ne                    | Zjisit stav všech ohlášených požadavků.                         |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+
| GET           | ``/track/<rest_id>`` | Ne                    | Zjistit stav konkrétního požadavku s identifikátorem `rest_id`. |
+---------------+----------------------+-----------------------+-----------------------------------------------------------------+

/submit
+++++++

Ohlášení nové e-publikace a souvisejících metadat. Tento krok odstraňuje nutnost ruční práce uživatele, který by jinak ohlášení musel provést manuálně přes webové rozhraní.

Vzhledem k nutnosti odeslat v jednom kroku jednak samotný soubor, ale i strukturovaná metadata bylo rozhodnuto pro odeslání dat jako JSON strukturu v POST proměnné ``json_data``.

Vyžadované parametry
^^^^^^^^^^^^^^^^^^^^

+--------------------------+-----------------------------------------------------+
|     Jméno parametru      |                        Popis                        |
+==========================+=====================================================+
| ``nazev``                | Název e-knihy.                                      |
+--------------------------+-----------------------------------------------------+
| ``poradi_vydani``        | Pořadí, ve kterém byla kniha vydána.                |
+--------------------------+-----------------------------------------------------+
| ``misto_vydani``         | Místo vydání s přesností na město.                  |
+--------------------------+-----------------------------------------------------+
| ``rok_vydani``           | Rok ve kterém byla kniha vydána.                    |
+--------------------------+-----------------------------------------------------+
| ``zpracovatel_zaznamu``  | Jméno osoby zodopovědné za odeslání tohoto záznamu. |
+--------------------------+-----------------------------------------------------+
| ``nazev_souboru``        | Název nahrávaného souboru.                          |
+--------------------------+-----------------------------------------------------+

Volitelné parametry
^^^^^^^^^^^^^^^^^^^

+----------------------------+--------------------------------------------------------------------------+
|      Jméno parametru       |                                  Popis                                   |
+============================+==========================================================================+
| ``podnazev``               | Podnázev knihy.                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``cast``                   |                                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``nazev_casti``            |                                                                          |
+----------------------------+--------------------------------------------------------------------------+
| ``isbn``                   | ISBN které má být použité pro knihu. Pokud není uvedeno, bude přiděleno. |
+----------------------------+--------------------------------------------------------------------------+
| ``isbn_souboru_publikaci`` | ISBN souboru publikací.                                                  |
+----------------------------+--------------------------------------------------------------------------+
| ``author1``                | Autor knihy.                                                             |
+----------------------------+--------------------------------------------------------------------------+
| ``author2``                | Další autor knihy.                                                       |
+----------------------------+--------------------------------------------------------------------------+
| ``author3``                | Možnost uvést třetího autora knihy.                                      |
+----------------------------+--------------------------------------------------------------------------+
| ``nakladatel_vydavatel``   | Název nakladatele či vydavatele knihy.                                   |
+----------------------------+--------------------------------------------------------------------------+
| ``vydano_v_koedici_s``     | Vydáno v koedici s .. (jméno vydavatele).                                |
+----------------------------+--------------------------------------------------------------------------+
| ``cena``                   | Cena knihy v korunách.                                                   |
+----------------------------+--------------------------------------------------------------------------+
| ``url``                    | URL epublikace v katalogu vydavetele.                                    |
+----------------------------+--------------------------------------------------------------------------+
| ``anotace``                | Popis knihy. Maximálně 500 znaků.                                        |
+----------------------------+--------------------------------------------------------------------------+
| ``zpristupneni``           | Zpřístupnění knihy dalším knihovnám. Hodnoty viz tabulka dále.           |
+----------------------------+--------------------------------------------------------------------------+
| ``riv``                    | Kategorie RIVu.                                                          |
+----------------------------+--------------------------------------------------------------------------+

Zpřístupnění
````````````

Je možné nastavit volitelné zpřístupnění e-publikace různým knihovnám. Ze smlouvy plyne, že kniha je vždy zpřístupněna minimálně Národní knihovně České republiky.

+-------------------------------------------------------+----------------------------------------------------+
|                      Hodnota pole                     |                    Význam pole                     |
+=======================================================+====================================================+
| ``moravska-zemska-knihovna-v-brne``                   | Moravská zemská knihovna v Brně.                   |
+-------------------------------------------------------+----------------------------------------------------+
| ``vedecka-knihovna-v-olomouci``                       | Vědecká knihovna v Olomouci.                       |
+-------------------------------------------------------+----------------------------------------------------+
| ``jihoceska-vedecka-knihovna-v-ceskych-budejovicich`` | Jihočeská vědecká knihovna v Českých Budějovicích. |
+-------------------------------------------------------+----------------------------------------------------+
| ``studijni-a-vedecka-knihovna-v-hradci-kralove``      | Studijní a vědecká knihovna v Hradci Králové.      |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-karlovy-vary``                     | Krajská knihovna Karlovy Vary.                     |
+-------------------------------------------------------+----------------------------------------------------+
| ``stredoceska-vedecka-knihovna-v-kladne``             | Středočeská vědecká knihovna v Kladně.             |
+-------------------------------------------------------+----------------------------------------------------+
| ``moravskoslezska-vedecka-knihovna-v-ostrave``        | Moravskoslezská vědecká knihovna v Ostravě.        |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-vedecka-knihovna-v-liberci``                | Krajská vědecká knihovna v Liberci.                |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-v-pardubicich``                    | Krajská knihovna v Pardubicích.                    |
+-------------------------------------------------------+----------------------------------------------------+
| ``studijni-a-vedecka-knihovna-plzenskeho-kraje``      | Studijní a vědecká knihovna Plzeňského kraje.      |
+-------------------------------------------------------+----------------------------------------------------+
| ``mestska-knihovna-v-praze``                          | Městská knihovna v Praze.                          |
+-------------------------------------------------------+----------------------------------------------------+
| ``severoceska-vedecka-knihovna-v-usti-nad-labem``     | Severočeská vědecká knihovna v Ústí nad Labem.     |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-vysociny-havlickuv-brod``          | Krajská knihovna Vysočiny (Havlíčkův Brod).        |
+-------------------------------------------------------+----------------------------------------------------+
| ``krajska-knihovna-frantiska-bartose-ve-zline``       | Krajská knihovna Františka Bartoše ve Zlíně.       |
+-------------------------------------------------------+----------------------------------------------------+

RIV
```

Dále je možné vybrat kategorii pro RIV.

+--------------+-----------------------------------------------------------------------+
| Č. kategorie |                                 Význam                                |
+==============+=======================================================================+
|            1 | Společenské, humanitní a umělecké vědy (SHVa)                         |
+--------------+-----------------------------------------------------------------------+
|            2 | Společenské vědy (SHVb)                                               |
+--------------+-----------------------------------------------------------------------+
|            3 | Společenské vědy (SHVc)                                               |
+--------------+-----------------------------------------------------------------------+
|            4 | Technické a informatické vědy                                         |
+--------------+-----------------------------------------------------------------------+
|            5 | Zemědělské vědy (rostlinná výroba, živočišná výroba a potravinářství) |
+--------------+-----------------------------------------------------------------------+
|            6 | Vědy o Zemi                                                           |
+--------------+-----------------------------------------------------------------------+
|            7 | Matematické vědy                                                      |
+--------------+-----------------------------------------------------------------------+
|            8 | Fyzikální vědy (pouze pilíř II.)                                      |
+--------------+-----------------------------------------------------------------------+
|            9 | Chemické vědy (pouze pilíř II.)                                       |
+--------------+-----------------------------------------------------------------------+
|           10 | Biologické vědy (pouze pilíř II.)                                     |
+--------------+-----------------------------------------------------------------------+
|           11 | Lékařské vědy (pouze pilíř II.)                                       |
+--------------+-----------------------------------------------------------------------+

Návratová hodnota
^^^^^^^^^^^^^^^^^

Návratovou hodnotou volání url ``/submit`` je `rest_id`, unikátní identifikátor právě ohlášeného požadavku ve formátu `UUID`_. Tento identifikátor lze dále použít pro sledování průběhu ohlašování.

.. _UUID: https://en.wikipedia.org/wiki/Universally_unique_identifier


/track
++++++


/track/<rest_id>
++++++++++++++++



</rst>

</body>
</HTML>

{'fraction_non_alphanumeric': 0.48936642378962164, 'fraction_numerical': 0.0015534267855161446, 'mean_word_length': 0.5855274731718759, 'pattern_counts': {'":': 0, '<': 33, '<?xml version=': 0, '>': 33, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 93, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6195279', 'n_tokens_mistral': 5783, 'n_tokens_neox': 5597, 'n_words': 1073}