diff --git a/docs/conf.py b/docs/conf.py --- a/docs/conf.py +++ b/docs/conf.py @@ -6,5 +6,3 @@ django.setup() from swh.docs.sphinx.conf import * # NoQA - -extensions = ["sphinx.ext.autosectionlabel"] diff --git a/docs/endpoints/collection.rst b/docs/endpoints/collection.rst --- a/docs/endpoints/collection.rst +++ b/docs/endpoints/collection.rst @@ -1,3 +1,4 @@ +.. _API-create-deposit: Create deposit ^^^^^^^^^^^^^^^ diff --git a/docs/metadata.rst b/docs/metadata.rst --- a/docs/metadata.rst +++ b/docs/metadata.rst @@ -7,6 +7,8 @@ information describing the software artifact and the software project. +.. _metadata-requirements: + Metadata requirements --------------------- 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 @@ -3,8 +3,9 @@ Goal ---- -A client wishes to deposit only metadata about an origin or object in the -Software Heritage archive. + +A client wishes to deposit only metadata about an origin or object already +present in the Software Heritage archive. The metadata-deposit is a special deposit where no content is provided and the data transferred to Software Heritage is only @@ -13,18 +14,18 @@ Requirements ------------ -1. :ref:`Create a metadata-only deposit through a POST request` +1. Create a metadata-only deposit through a :ref:`POST request` 2. It is composed of ONLY one xml metadata file -3. It MUST comply with :ref:`the metadata requirements` +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 + - 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`