diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ developers-info uri-scheme-api uri-scheme-browse - uri-scheme-identifiers + uri-scheme-swhids uri-scheme-misc diff --git a/docs/uri-scheme-api-identifiers.rst b/docs/uri-scheme-api-swhids.rst rename from docs/uri-scheme-api-identifiers.rst rename to docs/uri-scheme-api-swhids.rst --- a/docs/uri-scheme-api-identifiers.rst +++ b/docs/uri-scheme-api-swhids.rst @@ -1,7 +1,9 @@ -Persistent identifiers ----------------------- +SWHIDs (persistent identifiers) +------------------------------- .. autosimple:: swh.web.api.views.identifiers.api_resolve_swhid .. autosimple:: swh.web.api.views.identifiers.api_swhid_known +.. autosimple:: swh.web.api.views.raw.api_raw_object + diff --git a/docs/uri-scheme-api.rst b/docs/uri-scheme-api.rst --- a/docs/uri-scheme-api.rst +++ b/docs/uri-scheme-api.rst @@ -9,7 +9,7 @@ .. include:: uri-scheme-api-graph.rst -.. include:: uri-scheme-api-identifiers.rst +.. include:: uri-scheme-api-swhids.rst .. include:: uri-scheme-api-origin.rst diff --git a/docs/uri-scheme-identifiers.rst b/docs/uri-scheme-swhids.rst rename from docs/uri-scheme-identifiers.rst rename to docs/uri-scheme-swhids.rst --- a/docs/uri-scheme-identifiers.rst +++ b/docs/uri-scheme-swhids.rst @@ -1,5 +1,5 @@ -URI scheme for Software Heritage identifiers -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +URI scheme for Software Heritage IDentifiers (SWHIDs) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ A subset of Software Heritage objects (contents, directories, releases and revisions) can be browsed using :ref:`persistent-identifiers`. Those