Page MenuHomeSoftware Heritage
Create Task
Maniphest T875

Add optional context parameters for the browsing revision view
Closed, MigratedEdits Locked
Actions

Description

Using the url https://archive.softwareheritage.org/browse/revision/<swh-id>?origin={<url>,<type>}, we can add context to the revision.

A revision by itself on the web-app does not have context.
As a result, we cannot know if the revision was created from a deposit or the deposit's origin.

With those optional parameters, we can search rapidly the revision context and show it together with the revision metadata and target directory.

So, in the end, when the HAL user clicks on the swh-id in the HAL webpage, that will open that revision page with the given context.

Revisions and Commits

rDWAPPS Web applications
rDWAPPSa8a8625c7da9 browse: Add origin context for revision view

Related Objects

Event Timeline

moranegg created this task.Dec 8 2017, 10:35 AM
moranegg mentioned this in T858: Identify a deposit in the archive after loading.
ardumont renamed this task from Add optional context parameters for revision view (aka injected deposits) to Add optional context parameters for the browsing revision view.Dec 8 2017, 11:22 AM
ardumont triaged this task as Normal priority.
ardumont updated the task description. (Show Details)
ardumont added projects: Web app, SWORD deposit.
anlambert added a subscriber: anlambert.Dec 8 2017, 11:28 AM

Working on it.

In order to match the browse URI scheme currently implemented, the revision view in a context of an origin will have one of the the following URLs:

  • /browse/origin/(origin_id)/revision/(revision_id)/
  • /browse/origin/(origin_type)/url/(origin_url)/revision/(revision_id)/
anlambert changed the task status from Open to Work in Progress.Dec 8 2017, 11:33 AM
anlambert claimed this task.
anlambert added a comment.EditedDec 8 2017, 11:41 AM

Thinking back on the URI scheme, using query parameters seems the right way after all.

The main reason is that currently, it is too costly to verify that a revision is tied to an origin
as it implies to get the whole revision history and check that it contains the revision id of interest.

So URLs will be:

  • /browse/revision/(revision_id)/?origin_id=(origin_id)
  • /browse/revision/(revision_id)/?origin_type=(origin_type)&origin_url=(origin_url)
anlambert closed this task as Resolved by committing rDWAPPSa8a8625c7da9: browse: Add origin context for revision view.Dec 8 2017, 5:22 PM
anlambert added a commit: rDWAPPSa8a8625c7da9: browse: Add origin context for revision view.
ardumont moved this task from Backlog to Archived on the SWORD deposit board.Nov 3 2020, 4:07 PM
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 9:57 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal