.. _baseapi_rest:

===================
Popis rozhraní
===================

REST rozhraní je soubor jednotlivých služeb. Tyto služby umožňují:
 
 - zjišťování seznamu balíčků v digitálním archivu
 - zjišťování změn v balíčcích
 - vkládání požadavků na stažení balíčků
 - vkládání požadavků na stažení souborů (komponent) z balíčků
 - zjišťování stavu požadavků na stažení
 - stahování připravených výsledků
 - zjišťování stavu požadavků na změny balíčků
 - stahování výsledků požadovaných změn.

Pro přenos výsledků a vkládání požadavků na změny do digitálního archivu  
je určeno primárně navazující :ref:`přenosové rozhraní <batchapi>`.

V samostatné kapitole jsou uvedena :ref:`doporučení pro implementaci <baseapi_impl>`.


.. _baseapi_rest_openapi:

OpenAPI
==========

Podrobná definice rozhraní je popsána pomocí OpenAPI. Definice obsahuje specifikaci
metod a podobu návratových *JSON* objektů.

Specifikace rozhraní ke stažení: :download:`openapi.yaml <openapi.yaml>`

.. openapi:: openapi.yaml