Differential D4774 Diff 16908 docs/specs/blueprint.rst

Changeset View

Standalone View

docs/specs/blueprint.rst

Show First 20 Lines • Show All 118 Lines • ▼ Show 20 Lines	5. Client updates existing deposit through the update uris (one or more POST
2. Server stores information received (metadata or software archive source		2. Server stores information received (metadata or software archive source
code or both)		code or both)

This would be the case for example if the client initially posted a		This would be the case for example if the client initially posted a
``partial`` deposit (e.g. only metadata with no archive, or an archive		``partial`` deposit (e.g. only metadata with no archive, or an archive
without metadata, or a split archive because the initial one exceeded		without metadata, or a split archive because the initial one exceeded
the limit size imposed by swh repository deposit).		the limit size imposed by swh repository deposit).

.. note::		The content of a deposit can only be updated while it is in the ``partial``
		state; this causes the content to be replaced (the old version is discarded).

It is currently only possible to update deposits in the ``partial`` state,		Its metadata, however, can also be updated while in the ``done`` state;
but we are planning to allow depositing metadata in the ``done`` state		which adds a new version of the metadata in the SWH archive,
		ardumontUnsubmitted Not Done Inline Actions one(s). ardumont: one(s).
as well.		in addition to the old one(s).
In this state, ``In-Progress`` is not allowed, so the deposit cannot go back		In this state, ``In-Progress`` is not allowed, so the deposit cannot go back
in the ``partial`` state, but only to ``deposited``.		in the ``partial`` state, but only to ``deposited``.
		As a failsafe, to avoid accidentally updating the wrong deposit, this requires
		the ``X-Check-SWHID`` HTTP header to be set to the value of the SWHID of the
		deposit's content (returned after the deposit finished loading).


Schema representation		Schema representation
^^^^^^^^^^^^^^^^^^^^^		^^^^^^^^^^^^^^^^^^^^^

Scenario: updating a deposit via SWORDv2_ protocol:		Scenario: updating a deposit via SWORDv2_ protocol:

.. figure:: ../images/deposit-update-chart.svg		.. figure:: ../images/deposit-update-chart.svg
▲ Show 20 Lines • Show All 49 Lines • Show Last 20 Lines