Skip to content
Snippets Groups Projects
Commit 51dabba3 authored by Stefano Zacchiroli's avatar Stefano Zacchiroli
Browse files

doc: reference SWHID using explicit anchors

parent 533628aa
No related branches found
No related tags found
No related merge requests found
URI scheme for Software Heritage identifiers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A subset of Software Heritage objects (contents, directories, releases and revisions)
can be browsed using :ref:`persistent-identifiers`. Those identifiers
are guaranteed to remain stable (persistent) over time.
A subset of Software Heritage objects (contents, directories, releases and
revisions) can be browsed using :ref:`SWHIDs <persistent-identifiers>`. Those
identifiers are guaranteed to remain stable (persistent) over time.
.. http:get:: /(swh_id)/
......@@ -11,9 +12,9 @@ are guaranteed to remain stable (persistent) over time.
A redirection to the adequate HTML view will be performed when
reaching it.
:param string swh_id: a persistent identifier for a Software Heritage object
(see the :ref:`persistent-identifiers` section to learn more
about its syntax)
:param string swh_id: a persistent identifier for a Software Heritage
object, or SWHID (see :ref:`persistent identifiers
<persistent-identifiers>` to learn more about its syntax)
:resheader Location: the redirection URL for browsing the Software Heritage object
associated to the provided identifier
:statuscode 302: no error
......
......@@ -12,7 +12,7 @@ from swh.web.common.exc import handle_view_exception
def swh_id_browse(request, swh_id):
"""
Django view enabling to browse the archive using
:ref:`persistent-identifiers`.
:ref:`SWHIDs <persistent-identifiers>`.
The url that points to it is :http:get:`/(swh_id)/`.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment