Skip to content

Simplify/update the SWHIDs returned from a SWORD deposit

For a SWORD deposit we must now return SWHIDs with maximal information corresponding to the new SWHID specification.

According to the current Deposit documentation, the information currently returned is the following:

{
 'deposit_id': '11',
 'deposit_status': 'done',
 'deposit_swh_id': 'swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9',
 'deposit_swh_id_context': 'swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9;origin=https://forge.softwareheritage.org/source/jesuisgpl/',
 'deposit_swh_anchor_id': 'swh:1:rev:e76ea49c9ffbb7f73611087ba6e999b19e5d71eb',
 'deposit_swh_anchor_id_context': 'swh:1:rev:e76ea49c9ffbb7f73611087ba6e999b19e5d71eb;origin=https://forge.softwareheritage.org/source/jesuisgpl/',
 'deposit_status_detail': 'The deposit has been successfully \
                           loaded into the Software Heritage archive'
}

This can be simplified (and enhanced) using the new SWHID qualifiers anchor, path and visit, and returning for the swh_id_context the full contextual information (like is now done in the new permalinks box), as follows:

{
 'deposit_id': '11',
 'deposit_status': 'done',
 'deposit_swh_id': 'swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9',
 'deposit_swh_id_context': 'swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9;origin=https://forge.softwareheritage.org/source/jesuisgpl/;visit=swh:1:snp:68c0d26104d47e278dd6be07ed61fafb561d0d20;anchor=swh:1:rev:e76ea49c9ffbb7f73611087ba6e999b19e5d71eb;path=/',
 'deposit_status_detail': 'The deposit has been successfully \
                           loaded into the Software Heritage archive'
}

The deposit_swh_anchor_id and deposit_swh_anchor_id_context fields are no longer needed.

Related https://gitlab.ccsd.cnrs.fr/ccsd/hal/-/issues/264


Migrated from T2398 (view on Phabricator)

Edited by Phabricator Migration user