diff --git a/docs/specs/spec-meta-deposit.rst b/docs/specs/spec-meta-deposit.rst --- a/docs/specs/spec-meta-deposit.rst +++ b/docs/specs/spec-meta-deposit.rst @@ -1,8 +1,8 @@ The metadata-deposit -==================== +^^^^^^^^^^^^^^^^^^^^ Goal ----- +==== A client wishes to deposit only metadata about an origin or object already present in the Software Heritage archive. @@ -12,7 +12,7 @@ the metadata about an object in the archive. Requirements ------------- +============ 1. Create a metadata-only deposit through a :ref:`POST request` 2. It is composed of ONLY one xml metadata file @@ -33,7 +33,7 @@ .. _qualifiers: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers A complete metadata example ---------------------------- +=========================== The reference element is included in the metadata xml atomEntry under the swh namespace: @@ -70,14 +70,14 @@ References -^^^^^^^^^^ +========== The metadata reference can be either on: - an origin - a graph object (core SWHID with or without qualifiers) Origins -======= +------- The metadata may be on an origin, identified by the origin's URL: @@ -90,7 +90,7 @@ Graph objects -============= +------------- It may also reference an object in the `SWH graph `: contents, directories, revisions, releases, and snapshots: @@ -127,7 +127,7 @@ Loading procedure ------------------- +================= In this case, the metadata-deposit will be injected as a metadata entry of the relevant object, with the information about the contributor of the deposit.