diff --git a/docs/specs/spec-meta-deposit.rst b/docs/specs/spec-meta-deposit.rst index 65224769..04c724c7 100644 --- a/docs/specs/spec-meta-deposit.rst +++ b/docs/specs/spec-meta-deposit.rst @@ -1,99 +1,99 @@ The metadata-deposit ==================== Goal ---- A client wishes to deposit only metadata about an object 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 the metadata about an object or several objects in the archive. Requirements ------------ The scope of the meta-deposit is different than the sparse-deposit. While a sparse-deposit creates a revision with referenced directories and content files, the metadata-deposit references one of the following: - origin - snapshot - revision - release A complete metadata example --------------------------- The reference element is included in the metadata xml atomEntry under the swh namespace: TODO: publish schema at https://www.softwareheritage.org/schema/2018/deposit .. code:: xml - - - HAL - hal@ccsd.cnrs.fr - - hal - hal-01243573 - The assignment problem - https://hal.archives-ouvertes.fr/hal-01243573 - other identifier, DOI, ARK - Domain - description - - author1 - Inria - UPMC - - - author2 - Inria - UPMC - - - - - - - + + + HAL + hal@ccsd.cnrs.fr + + hal + hal-01243573 + The assignment problem + https://hal.archives-ouvertes.fr/hal-01243573 + other identifier, DOI, ARK + Domain + description + + author1 + Inria + UPMC + + + author2 + Inria + UPMC + + + + + + + Examples by target type ^^^^^^^^^^^^^^^^^^^^^^^ Reference an origin: .. code:: xml Reference a snapshot, revision or release: .. code:: xml With ${type} in {snp (snapshot), rev (revision), rel (release) }: Loading procedure ------------------ In this case, the metadata-deposit will be injected as a metadata entry at the appropriate level (origin_metadata, revision_metadata, etc.) with the information about the contributor of the deposit. Contrary to the complete and sparse deposit, there will be no object creation.