Page MenuHomeSoftware Heritage
Files F9697730

D3939.id13877.diff
No OneTemporary
Actions

D3939.id13877.diff
View Options

diff --git a/docs/specs/spec-loading.rst b/docs/specs/spec-loading.rst
--- a/docs/specs/spec-loading.rst
+++ b/docs/specs/spec-loading.rst
@@ -52,9 +52,8 @@
Origin artifact
~~~~~~~~~~~~~~~
-We create an origin using the url in the deposited metadata.
-The current deposit and future deposits with the same url or external_id
-will be associated to this origin.
+We create an origin URL by concatenating the client URI and the value of the
+Slug header of the initial POST request of the deposit.
.. code-block:: json
@@ -103,88 +102,33 @@
Snapshot artifact
~~~~~~~~~~~~~~~~~
-The snapshot represents one deposit push. The master branch points to a
-synthetic revision. We will create a second branch pointing to a release
-artifact, if the indicate that the deposit is a release with a `releaseNotes`.
+The snapshot represents one deposit push. The ``HEAD`` branch points to a
+synthetic revision.
-.. code-block:: json
+ .. code-block:: json
{
"snapshot": {
"branches": {
- "master": {
+ "HEAD": {
"target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52",
"target_type": "revision",
"target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/"
}
- "refs/tags/v1.1": {
- "target": "a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97",
- "target_type": "release",
- "target_url": "/api/1/release/a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97/"
- }
},
"id": "a3773941561cc557853898773a19c07cfe2efc5a",
"next_branch": null
}
}
-Release artifact
-~~~~~~~~~~~~~~~~
-The content is deposited with a set of descriptive metadata in the CodeMeta
-vocabulary. The following CodeMeta terms implies that the
-artifact is a release:
-
-- `releaseNotes`
-- `softwareVersion`
-
-If present, a release artifact will be created with the mapping below:
-
-+-------------------+-----------------------------------+-----------------+----------------+
-| SWH release field | Description | CodeMeta term | Fallback value |
-+===================+===================================+=================+================+
-| target | revision containing all metadata | X |X |
-+-------------------+-----------------------------------+-----------------+----------------+
-| target_type | revision | X |X |
-+-------------------+-----------------------------------+-----------------+----------------+
-| name | release or tag name (mandatory) | softwareVersion | X |
-+-------------------+-----------------------------------+-----------------+----------------+
-| message | message associated with release | releaseNotes | X |
-+-------------------+-----------------------------------+-----------------+----------------+
-| date | release date = publication date | datePublished | deposit_date |
-+-------------------+-----------------------------------+-----------------+----------------+
-| author | deposit client | author | client |
-+-------------------+-----------------------------------+-----------------+----------------+
-
-
-.. code-block:: json
-
- {
- "release": {
- "author": {
- "email": "hal@ccsd.cnrs.fr",
- "fullname": "HAL <phal@ccsd.cnrs.fr>",
- "name": "HAL"
- },
- "author_url": "/api/1/person/x/",
- "date": "2019-05-27T16:28:33+02:00",
- "id": "a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97",
- "message": "AffectationRO Version 1.1 - added new feature\n",
- "name": "1.1",
- "synthetic": true,
- "target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52",
- "target_type": "revision",
- "target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/"
- }
- }
-
+Note that previous versions of the deposit-loader named the branch ``master``
+instead, and created release branches under certain conditions.
Revision artifact
~~~~~~~~~~~~~~~~~
-The metadata sent with the deposit is included in the revision which affects
-the hash computation, thus resulting in a unique identifier.
-This way, by depositing the same content with different metadata, will result
-in two different revisions in the SWH archive.
+The metadata sent with the deposit is stored in outside the revision,
+and does not affect the hash computation.
The date mapping
^^^^^^^^^^^^^^^^
@@ -423,23 +367,10 @@
Metadata loading
~~~~~~~~~~~~~~~~
-- the metadata received with the deposit are kept in the `metadata` fields
- of the revision and in the ```origin_metadata`` table to facilitate search
- over origin metadata.
+- the metadata received with the deposit are kept in a dedicated table
+ ``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin``
+ tables.
-- provider\_id and tool\_id are resolved by the prepare\_metadata method in the
- loader-core
-
-- the origin\_metadata entry is sent to storage by the send\_origin\_metadata
- in the loader-core
-
-origin\_metadata table:
-
-::
+- ``authority`` is computed from the deposit client information, and ``fetcher``
+ is the deposit loader.
- id bigint PK
- origin bigint
- discovery_date date
- provider_id bigint FK // (from provider table)
- tool_id bigint FK // indexer_configuration_id tool used for extraction
- metadata jsonb // before translation

File Metadata

Mime Type
text/plain
Expires
Mon, Aug 18, 12:45 AM (3 w, 3 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3224575

Event Timeline

About · Developer information · Legal