diff --git a/use-cases/src/site/sphinx/lifecycle.rst b/use-cases/src/site/sphinx/lifecycle.rst index 15b54b5..6f30bf8 100644 --- a/use-cases/src/site/sphinx/lifecycle.rst +++ b/use-cases/src/site/sphinx/lifecycle.rst @@ -37,6 +37,10 @@ The suite comes with a pre-built set of implemented lifecycles with their STEPS, .. figure:: _static/imgs/2phase_lc.png :alt: 2 - PHASES Lifecycle +TBD : steps phases, involved events + + + ==================== 3 - Phases Lifecycle ==================== @@ -44,6 +48,8 @@ The suite comes with a pre-built set of implemented lifecycles with their STEPS, :alt: 3 - PHASES Lifecycle +TBD : steps phases, involved events + ***************** Operation on documents ***************** @@ -51,18 +57,21 @@ Operation on documents .. warning:: Read and write permissions on *projects* are defined in :doc:`ucd` -Common operations -***************** While **projects** lifecycle can vary depending on the configuration declared in its related :doc:`ucd`, following operations are common and available for every **project**. -Checkout the `swagger`_ documentation. + +================= +Basic operations +================= - Create New : The starting operation of every *project*. It expects a JSON metadata document, which will constitute the :ref:`document` section of the **project**. - Edit : Allows for the replacement of :ref:`document`. - Delete : Deletes the specified **project** - List / get by Id : allows access to projects. +======== Querying -===== +======== + Querying allows for the filtered access of subsets of **projects**. The following options are allowed in query operations @@ -73,9 +82,10 @@ The following options are allowed in query operations - paging : limit and offset - projection : projects fields selection to return in result - +==================================== Registering / Unregistering FileSets -================================== +==================================== + :ref:`filesets` are sets of files representing a single entity, which need to be handled together (e.g. a dataset and its index, a file and its crc). Each :ref:`filesets` is (un)registered at a particular path of the :ref:`document` with requests with the following information : @@ -100,9 +110,10 @@ Each :ref:`filesets` is (un)registered at a particular path of the :ref:`documen .. warning:: Paths are required to match a single field for fileset registration. - +=============== Executing STEPS =============== + In order to expose a common API while serving varying / customizable possible scenarios, the service expose only a single method for STEP execution. The method **perform STEP** allows for the execution of the configured STEPs by serving requests with the following information: