diff --git a/docs/api/use-cases.rst b/docs/api/use-cases.rst --- a/docs/api/use-cases.rst +++ b/docs/api/use-cases.rst @@ -175,7 +175,18 @@ Client asks for operation status -------------------------------- -8. Operation status can be read through a GET query to the *state iri*. +At any time during the next step, operation status can be read through +a GET query to the *state iri*. + + +Deposit loading +--------------- + +In one of the previous steps, when a deposit was created or loaded without +``In-Progress: true``, the deposit server created a load task and submitted it +to :ref:`swh-scheduler `. + +This triggers the following steps: Server: Triggering deposit checks @@ -198,4 +209,13 @@ This is described in the :ref:`loading specifications document `. + +Completing the deposit +---------------------- + +When this is all done, the loaders notify the deposit server, which sets +the deposit status to ``done``. + +This can then be polled by deposit clients, using the *state iri*. + .. _SWORDv2: http://swordapp.github.io/SWORDv2-Profile/SWORDProfile.html