Page MenuHomeSoftware Heritage
Differential D6730

api: Fix documentation of the format used for git date fields
ClosedPublic
Actions

Authored by vlorentz on Dec 2 2021, 3:50 PM.

Details

Reviewers
anlambert
Group Reviewers
Reviewers
Commits
rDWAPPS9502510d8092: api: Fix documentation of the format used for git date fields
Summary

They may contain negative UTC offsets, which is allowed by RFC3339,
but not by ISO8601.

See the last paragraph of https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC for details

I also removed (in UTC) because it's not true.

Diff Detail

Repository
rDWAPPS Web applications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Dec 2 2021, 3:50 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptDec 2 2021, 3:50 PM
vlorentz edited the summary of this revision. (Show Details)Dec 2 2021, 3:52 PM
vlorentz added a child revision: D6731: api: Specify date formats more precisely.Dec 2 2021, 3:54 PM
vlorentz edited the summary of this revision. (Show Details)Dec 2 2021, 3:59 PM
swh-public-ci added a comment.Dec 2 2021, 4:08 PM

Build is green

Patch application report for D6730 (id=24453)

Rebasing onto 284eec7e75...

Current branch diff-target is up to date.
Changes applied before test
commit 9502510d8092715c96894f7699a6c8c589865d74
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Dec 2 15:50:50 2021 +0100

    api: Fix documentation of the format used for git date fields
    
    They may contain negative UTC offsets, which is allowed by RFC3339,
    but not by ISO8601.

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/1259/ for more details.

Harbormaster completed remote builds in B25329: Diff 24453.Dec 2 2021, 4:08 PM
vlorentz requested review of this revision.Dec 2 2021, 4:08 PM
anlambert accepted this revision.Dec 2 2021, 4:19 PM
This revision is now accepted and ready to land.Dec 2 2021, 4:19 PM
Closed by commit rDWAPPS9502510d8092: api: Fix documentation of the format used for git date fields (authored by vlorentz). · Explain WhyDec 6 2021, 10:54 AM
This revision was automatically updated to reflect the committed changes.
vlorentz added a commit: rDWAPPS9502510d8092: api: Fix documentation of the format used for git date fields.

Revision Contents
Changeset List

PathSize
swh/
web/
api/
views/
2 lines
5 lines
tests/
api/
9 lines

Diff 24498

View Options

swh/web/api/views/release.py

.. _swh-loading-specs:
Loading specification Loading specification
===================== =====================
An important part of the deposit specifications is the loading procedure where An important part of the deposit specifications is the loading procedure where
a deposit is ingested into the Software Heritage (archive), using a deposit is ingested into the Software Heritage Archive (SWH) using
the tarball loader and the complete process of software artifacts creation the deposit loader and the complete process of software artifacts creation
in the archive. in the archive.
Tarball Loading Deposit Loading
--------------- ---------------
The ``swh-loader-tar`` module is already able to inject tarballs in swh The ``swh.loader.package.deposit`` module is able to inject zipfile/tarball's
with very limited metadata (mainly the origin). content in SWH with its metadata.
The loading of the deposit will use the deposit's associated data: The loading of the deposit will use the deposit's associated data:
* the metadata * the metadata
* the archive(s) * the archive file(s)
Artifacts creation Artifacts creation
------------------ ------------------
Deposit to artifacts mapping Deposit to artifacts mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a global view of the deposit ingestion This is a global view of the deposit ingestion
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| swh artifact | representation in deposit | | swh artifact | representation in deposit |
+====================================+=========================================+ +====================================+=========================================+
| origin | https://hal.inria.fr/hal-id | | origin | https://hal.inria.fr/hal-id |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| origin_metadata | aggregated metadata | | raw_extrinsic_metadata | aggregated metadata |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| snapshot | reception of all occurrences (branches) | | snapshot | reception of all occurrences (branches) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| branches | master & | | branches | master & tags for releases |
| | branch (optional): tag to release | | | (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| release | (optional) synthetic release created | | release | (optional) synthetic release created |
| | from metadata | | | from metadata (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| revision | synthetic revision pointing to | | revision | synthetic revision pointing to |
| | the expanded submitted tarball | | | the directory (see below) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| directory | root directory of the expanded submitted| | directory | root directory of the expanded submitted|
| | tarball | | | tarball |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
Origin artifact Origin artifact
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
We create an origin URL by concatenating the client URI and the value of the We create an origin URL by concatenating the client's `provider_url` and the
Slug header of the initial POST request of the deposit. value of the Slug header of the initial POST request of the deposit.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/get/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

this one too, for consistency

vlorentz: this one too, for consistency
{ {
"origin": { "origin_visits_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/",
"id": 89283768, "url": "https://hal.archives-ouvertes.fr/hal-02560320"
"origin_visits_url": "/api/1/origin/89283768/visits/",
"type": "deposit",
"url": "https://hal.archives-ouvertes.fr/hal-02140606"
}
} }
Visits Visits
~~~~~~ ~~~~~~
We identify with a visit each deposit push of the same external_id. We identify with a visit each deposit push of the same `external_id`.
Here in the example below, two snapshots are identified by two different visits. Here in the example below, two snapshots are identified by two different visits.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

could we keep this block as json, and move the shell command out of the block?

vlorentz: could we keep this block as json, and move the shell command out of the block?
douarddaAuthorUnsubmitted
Done
Inline Actions

why not, let me do that

douardda: why not, let me do that
[
{ {
"visits": [ "date": "2020-05-14T11:59:55.942964+00:00",
{ "metadata": {},
"date": "2019-06-03T09:28:10.223007+00:00", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"origin": 89283768, "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/2/",
"origin_visit_url": "/api/1/origin/89283768/visit/2/", "snapshot": "e5e82d064a9c3df7464223042e0c55d72ccff7f0",
"snapshot": "a3773941561cc557853898773a19c07cfe2efc5a", "snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/e5e82d064a9c3df7464223042e0c55d72ccff7f0/",
"snapshot_url": "/api/1/snapshot/a3773941561cc557853898773a19c07cfe2efc5a/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 2 "visit": 2
}, },
{ {
"date": "2019-05-27T12:23:31.037273+00:00", "date": "2020-05-14T11:59:41.094260+00:00",
"origin": 89283768, "metadata": {},
"origin_visit_url": "/api/1/origin/89283768/visit/1/", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"snapshot": "43fdb8291f1bf6962211c370e394f6abb1cbe01d", "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/1/",
"snapshot_url": "/api/1/snapshot/43fdb8291f1bf6962211c370e394f6abb1cbe01d/", "snapshot": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 1 "visit": 1
} }
] ]
}
Snapshot artifact Snapshot artifact
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
The snapshot represents one deposit push. The ``HEAD`` branch points to a The snapshot represents one deposit push. The ``HEAD`` branch points to a
synthetic revision. synthetic revision.
For example:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

same

vlorentz: same
{ {
"snapshot": {
"branches": { "branches": {
"HEAD": { "HEAD": {
"target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", "target": "2122424b547a8eca9282ba3131ec61ff1d8df7d4",
"target_type": "revision", "target_type": "revision",
"target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" "target_url": "https://archive.softwareheritage.org/api/1/revision/2122424b547a8eca9282ba3131ec61ff1d8df7d4/"
} }
}, },
"id": "a3773941561cc557853898773a19c07cfe2efc5a", "id": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"next_branch": null "next_branch": null
} }
}
Note that previous versions of the deposit-loader named the branch ``master`` Note that previous versions of the deposit-loader named the branch ``master``
instead, and created release branches under certain conditions. instead, and created release branches under certain conditions.
Release artifact Release artifact
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. warning:: .. warning::
▲ Show 20 Lines • Show All 311 Lines • ▼ Show 20 Lines
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
- the metadata received with the deposit are kept in a dedicated table - the metadata received with the deposit are kept in a dedicated table
``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin`` ``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin``
tables. tables.
- ``authority`` is computed from the deposit client information, and ``fetcher`` - ``authority`` is computed from the deposit client information, and ``fetcher``
is the deposit loader. is the deposit loader.
View Options

swh/web/api/views/revision.py

.. _swh-loading-specs:
Loading specification Loading specification
===================== =====================
An important part of the deposit specifications is the loading procedure where An important part of the deposit specifications is the loading procedure where
a deposit is ingested into the Software Heritage (archive), using a deposit is ingested into the Software Heritage Archive (SWH) using
the tarball loader and the complete process of software artifacts creation the deposit loader and the complete process of software artifacts creation
in the archive. in the archive.
Tarball Loading Deposit Loading
--------------- ---------------
The ``swh-loader-tar`` module is already able to inject tarballs in swh The ``swh.loader.package.deposit`` module is able to inject zipfile/tarball's
with very limited metadata (mainly the origin). content in SWH with its metadata.
The loading of the deposit will use the deposit's associated data: The loading of the deposit will use the deposit's associated data:
* the metadata * the metadata
* the archive(s) * the archive file(s)
Artifacts creation Artifacts creation
------------------ ------------------
Deposit to artifacts mapping Deposit to artifacts mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a global view of the deposit ingestion This is a global view of the deposit ingestion
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| swh artifact | representation in deposit | | swh artifact | representation in deposit |
+====================================+=========================================+ +====================================+=========================================+
| origin | https://hal.inria.fr/hal-id | | origin | https://hal.inria.fr/hal-id |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| origin_metadata | aggregated metadata | | raw_extrinsic_metadata | aggregated metadata |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| snapshot | reception of all occurrences (branches) | | snapshot | reception of all occurrences (branches) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| branches | master & | | branches | master & tags for releases |
| | branch (optional): tag to release | | | (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| release | (optional) synthetic release created | | release | (optional) synthetic release created |
| | from metadata | | | from metadata (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| revision | synthetic revision pointing to | | revision | synthetic revision pointing to |
| | the expanded submitted tarball | | | the directory (see below) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| directory | root directory of the expanded submitted| | directory | root directory of the expanded submitted|
| | tarball | | | tarball |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
Origin artifact Origin artifact
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
We create an origin URL by concatenating the client URI and the value of the We create an origin URL by concatenating the client's `provider_url` and the
Slug header of the initial POST request of the deposit. value of the Slug header of the initial POST request of the deposit.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/get/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

this one too, for consistency

vlorentz: this one too, for consistency
{ {
"origin": { "origin_visits_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/",
"id": 89283768, "url": "https://hal.archives-ouvertes.fr/hal-02560320"
"origin_visits_url": "/api/1/origin/89283768/visits/",
"type": "deposit",
"url": "https://hal.archives-ouvertes.fr/hal-02140606"
}
} }
Visits Visits
~~~~~~ ~~~~~~
We identify with a visit each deposit push of the same external_id. We identify with a visit each deposit push of the same `external_id`.
Here in the example below, two snapshots are identified by two different visits. Here in the example below, two snapshots are identified by two different visits.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

could we keep this block as json, and move the shell command out of the block?

vlorentz: could we keep this block as json, and move the shell command out of the block?
douarddaAuthorUnsubmitted
Done
Inline Actions

why not, let me do that

douardda: why not, let me do that
[
{ {
"visits": [ "date": "2020-05-14T11:59:55.942964+00:00",
{ "metadata": {},
"date": "2019-06-03T09:28:10.223007+00:00", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"origin": 89283768, "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/2/",
"origin_visit_url": "/api/1/origin/89283768/visit/2/", "snapshot": "e5e82d064a9c3df7464223042e0c55d72ccff7f0",
"snapshot": "a3773941561cc557853898773a19c07cfe2efc5a", "snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/e5e82d064a9c3df7464223042e0c55d72ccff7f0/",
"snapshot_url": "/api/1/snapshot/a3773941561cc557853898773a19c07cfe2efc5a/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 2 "visit": 2
}, },
{ {
"date": "2019-05-27T12:23:31.037273+00:00", "date": "2020-05-14T11:59:41.094260+00:00",
"origin": 89283768, "metadata": {},
"origin_visit_url": "/api/1/origin/89283768/visit/1/", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"snapshot": "43fdb8291f1bf6962211c370e394f6abb1cbe01d", "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/1/",
"snapshot_url": "/api/1/snapshot/43fdb8291f1bf6962211c370e394f6abb1cbe01d/", "snapshot": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 1 "visit": 1
} }
] ]
}
Snapshot artifact Snapshot artifact
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
The snapshot represents one deposit push. The ``HEAD`` branch points to a The snapshot represents one deposit push. The ``HEAD`` branch points to a
synthetic revision. synthetic revision.
For example:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

same

vlorentz: same
{ {
"snapshot": {
"branches": { "branches": {
"HEAD": { "HEAD": {
"target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", "target": "2122424b547a8eca9282ba3131ec61ff1d8df7d4",
"target_type": "revision", "target_type": "revision",
"target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" "target_url": "https://archive.softwareheritage.org/api/1/revision/2122424b547a8eca9282ba3131ec61ff1d8df7d4/"
} }
}, },
"id": "a3773941561cc557853898773a19c07cfe2efc5a", "id": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"next_branch": null "next_branch": null
} }
}
Note that previous versions of the deposit-loader named the branch ``master`` Note that previous versions of the deposit-loader named the branch ``master``
instead, and created release branches under certain conditions. instead, and created release branches under certain conditions.
Release artifact Release artifact
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. warning:: .. warning::
▲ Show 20 Lines • Show All 311 Lines • ▼ Show 20 Lines
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
- the metadata received with the deposit are kept in a dedicated table - the metadata received with the deposit are kept in a dedicated table
``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin`` ``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin``
tables. tables.
- ``authority`` is computed from the deposit client information, and ``fetcher`` - ``authority`` is computed from the deposit client information, and ``fetcher``
is the deposit loader. is the deposit loader.
View Options

swh/web/tests/api/test_apidoc.py

.. _swh-loading-specs:
Loading specification Loading specification
===================== =====================
An important part of the deposit specifications is the loading procedure where An important part of the deposit specifications is the loading procedure where
a deposit is ingested into the Software Heritage (archive), using a deposit is ingested into the Software Heritage Archive (SWH) using
the tarball loader and the complete process of software artifacts creation the deposit loader and the complete process of software artifacts creation
in the archive. in the archive.
Tarball Loading Deposit Loading
--------------- ---------------
The ``swh-loader-tar`` module is already able to inject tarballs in swh The ``swh.loader.package.deposit`` module is able to inject zipfile/tarball's
with very limited metadata (mainly the origin). content in SWH with its metadata.
The loading of the deposit will use the deposit's associated data: The loading of the deposit will use the deposit's associated data:
* the metadata * the metadata
* the archive(s) * the archive file(s)
Artifacts creation Artifacts creation
------------------ ------------------
Deposit to artifacts mapping Deposit to artifacts mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a global view of the deposit ingestion This is a global view of the deposit ingestion
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| swh artifact | representation in deposit | | swh artifact | representation in deposit |
+====================================+=========================================+ +====================================+=========================================+
| origin | https://hal.inria.fr/hal-id | | origin | https://hal.inria.fr/hal-id |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| origin_metadata | aggregated metadata | | raw_extrinsic_metadata | aggregated metadata |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| snapshot | reception of all occurrences (branches) | | snapshot | reception of all occurrences (branches) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| branches | master & | | branches | master & tags for releases |
| | branch (optional): tag to release | | | (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| release | (optional) synthetic release created | | release | (optional) synthetic release created |
| | from metadata | | | from metadata (not yet implemented) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| revision | synthetic revision pointing to | | revision | synthetic revision pointing to |
| | the expanded submitted tarball | | | the directory (see below) |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
| directory | root directory of the expanded submitted| | directory | root directory of the expanded submitted|
| | tarball | | | tarball |
+------------------------------------+-----------------------------------------+ +------------------------------------+-----------------------------------------+
Origin artifact Origin artifact
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
We create an origin URL by concatenating the client URI and the value of the We create an origin URL by concatenating the client's `provider_url` and the
Slug header of the initial POST request of the deposit. value of the Slug header of the initial POST request of the deposit.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/get/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

this one too, for consistency

vlorentz: this one too, for consistency
{ {
"origin": { "origin_visits_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/",
"id": 89283768, "url": "https://hal.archives-ouvertes.fr/hal-02560320"
"origin_visits_url": "/api/1/origin/89283768/visits/",
"type": "deposit",
"url": "https://hal.archives-ouvertes.fr/hal-02140606"
}
} }
Visits Visits
~~~~~~ ~~~~~~
We identify with a visit each deposit push of the same external_id. We identify with a visit each deposit push of the same `external_id`.
Here in the example below, two snapshots are identified by two different visits. Here in the example below, two snapshots are identified by two different visits.
For examples:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visits/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

could we keep this block as json, and move the shell command out of the block?

vlorentz: could we keep this block as json, and move the shell command out of the block?
douarddaAuthorUnsubmitted
Done
Inline Actions

why not, let me do that

douardda: why not, let me do that
[
{ {
"visits": [ "date": "2020-05-14T11:59:55.942964+00:00",
{ "metadata": {},
"date": "2019-06-03T09:28:10.223007+00:00", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"origin": 89283768, "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/2/",
"origin_visit_url": "/api/1/origin/89283768/visit/2/", "snapshot": "e5e82d064a9c3df7464223042e0c55d72ccff7f0",
"snapshot": "a3773941561cc557853898773a19c07cfe2efc5a", "snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/e5e82d064a9c3df7464223042e0c55d72ccff7f0/",
"snapshot_url": "/api/1/snapshot/a3773941561cc557853898773a19c07cfe2efc5a/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 2 "visit": 2
}, },
{ {
"date": "2019-05-27T12:23:31.037273+00:00", "date": "2020-05-14T11:59:41.094260+00:00",
"origin": 89283768, "metadata": {},
"origin_visit_url": "/api/1/origin/89283768/visit/1/", "origin": "https://hal.archives-ouvertes.fr/hal-02560320",
"snapshot": "43fdb8291f1bf6962211c370e394f6abb1cbe01d", "origin_visit_url": "https://archive.softwareheritage.org/api/1/origin/https://hal.archives-ouvertes.fr/hal-02560320/visit/1/",
"snapshot_url": "/api/1/snapshot/43fdb8291f1bf6962211c370e394f6abb1cbe01d/", "snapshot": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"snapshot_url": "https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/",
"status": "full", "status": "full",
"type": "deposit", "type": "deposit",
"visit": 1 "visit": 1
} }
] ]
}
Snapshot artifact Snapshot artifact
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
The snapshot represents one deposit push. The ``HEAD`` branch points to a The snapshot represents one deposit push. The ``HEAD`` branch points to a
synthetic revision. synthetic revision.
For example:
.. code-block:: bash
$ http -pb https://archive.softwareheritage.org/api/1/snapshot/3e95ef6e04c381a34cc2f314576bc5644f2c797f/
would result in:
.. code-block:: json .. code-block:: json
vlorentzUnsubmitted
Not Done
Inline Actions

same

vlorentz: same
{ {
"snapshot": {
"branches": { "branches": {
"HEAD": { "HEAD": {
"target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", "target": "2122424b547a8eca9282ba3131ec61ff1d8df7d4",
"target_type": "revision", "target_type": "revision",
"target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" "target_url": "https://archive.softwareheritage.org/api/1/revision/2122424b547a8eca9282ba3131ec61ff1d8df7d4/"
} }
}, },
"id": "a3773941561cc557853898773a19c07cfe2efc5a", "id": "3e95ef6e04c381a34cc2f314576bc5644f2c797f",
"next_branch": null "next_branch": null
} }
}
Note that previous versions of the deposit-loader named the branch ``master`` Note that previous versions of the deposit-loader named the branch ``master``
instead, and created release branches under certain conditions. instead, and created release branches under certain conditions.
Release artifact Release artifact
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. warning:: .. warning::
▲ Show 20 Lines • Show All 311 Lines • ▼ Show 20 Lines
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
- the metadata received with the deposit are kept in a dedicated table - the metadata received with the deposit are kept in a dedicated table
``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin`` ``raw_extrinsic_metadata``, distinct from the ``revision`` and ``origin``
tables. tables.
- ``authority`` is computed from the deposit client information, and ``fetcher`` - ``authority`` is computed from the deposit client information, and ``fetcher``
is the deposit loader. is the deposit loader.
About · Developer information · Legal