Page MenuHomeSoftware Heritage

Identify a deposit in the archive after loading
Closed, MigratedEdits Locked

Description

As a software author
I want to find the deposit I made on HAL in the SWH archive
so that I can reference my software publication with a persistent url

  • return an identifier to the deposit client (so it will be on the client's web page)
  • decide how the web-app resolves the identifier
    • archive.softwareheritage.org/browse/revision/<swh-id>?origin={<url>,<type>}

open task T859 for web-view

Event Timeline

moranegg added a project: SWORD deposit.
moranegg moved this task from Backlog to Specifications on the Metadata workflow board.
moranegg renamed this task from deposit identification to Identify a deposit in the archive after loading.Dec 8 2017, 10:23 AM
moranegg closed this task as Resolved.
moranegg updated the task description. (Show Details)
moranegg updated the task description. (Show Details)

return an identifier to the deposit client (so it will be on the client's web page)

The swh-id is returned by deposit's /1/<collection>/<id>/status/ endpoint, in the status_swh_id field as demontrated.

decide how the web-app resolves the identifier

so far, we can access it either through the archive's endpoints:

  • /browse/revision/<swh-id>/ (not yet public)
  • /api/1/revision/<swh-id>/

archive.softwareheritage.org/browse/revision/<swh-id>?origin={<url>,<type>}

The missing part would be ?origin={<url>,<type>}.
But what is that supposed to do?

The missing part would be ?origin={<url>,<type>}.
But what is that supposed to do?

a revision by itself on the web-app doesn't have context so we can't know it was a deposit and the origin was hal
with the optinal parameters we can give context for a revision

so if the user on the HAL webpage cliked on the swh-id it shows him the revision page in context and not just a plain revision

opening a seperate task for that T875

a revision by itself on the web-app doesn't have context so we can't know it was a deposit and the origin was hal with the optinal parameters we can give context for a revision
so if the user on the HAL webpage cliked on the swh-id it shows him the revision page in context and not just a plain revision

Right!

opening a seperate task for that T875

Awesome!

Thanks.