diff --git a/docs/conf.py b/docs/conf.py --- a/docs/conf.py +++ b/docs/conf.py @@ -6,3 +6,5 @@ django.setup() from swh.docs.sphinx.conf import * # NoQA + +extensions = ["sphinx.ext.autosectionlabel"] 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 @@ -12,18 +12,24 @@ Requirements ------------ -The scope of the metadata-deposit is different than the -sparse-deposit. While a sparse-deposit creates a revision with referenced -directories and content files, the metadata-deposit references any of the -following: - -- origin -- snapshot -- release -- revision -- directory -- content +1. :ref:`Create a metadata-only deposit through a POST request` +2. It is composed of ONLY one xml metadata file +3. It MUST comply with :ref:`the metadata requirements` +4. It MUST reference an **object** or an **origin** in a deposit tag +5. The reference SHOULD exist in the SWH archive +6. The **object** reference MUST be a SWHID on one of the following artifact types: + - origin + - snapshot + - release + - revision + - directory + - content +7. The SWHID MAY be a `core identifier`_ with or without `qualifiers`_ +8. The SWHID MUST NOT reference a fragment of code with the classifier `lines` + +.. _core identifier: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#core-identifiers +.. _qualifiers: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers A complete metadata example ---------------------------