diff --git a/docs/specs/spec-meta-deposit.rst b/docs/specs/spec-meta-deposit.rst index 2d682449..9ba0c8ef 100644 --- a/docs/specs/spec-meta-deposit.rst +++ b/docs/specs/spec-meta-deposit.rst @@ -1,31 +1,104 @@ The meta-deposit ================ Goal ---- A client wishes to deposit only metadata about an object in the Software Heritage archive. The meta-deposit is a special deposit where no content is deposited and the data transfered to Software Heritage is only the metadata about an object or several objects in the archive. -The scope of the meta-deposit is larger than the sparse-deposit, because -with a meta-deposit all types of objects in the archive can be described -with the deposited metadata: +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 meta-deposit references one of the following: - origin - snapshot - revision - release -- directory -- content +A complete metadata example +--------------------------- +The reference element is included in the metadata xml atomEntry under the +swh namespace: + +.. 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 + + + + origin + https://github.com/user/repo + + + + +examples by target type +^^^^^^^^^^^^^^^^^^^^^^^ +snapshot +********* +.. code:: xml + + + + snapshot + swh:1:snp:aaaaaaaaaaaaaa... + + + +revision +******** +.. code:: xml + + + + revision + swh:1:rev:aaaaa............ + + + +release +******* +.. code:: xml + + + + release + swh:1:rel:aaaaaaaaaaaaaa.... + + + Loading procedure ------------------ In this case, the meta-deposit will be injected as a metadata entry at the appropriate level (origin_metadata, revision_metadata, etc.) and won't result in the creation of a new object like with the complete deposit and the sparse-deposit.