diff --git a/docs/index.rst b/docs/index.rst index 7d7cc33d..40c01591 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,30 +1,30 @@ .. _swh-web: Software Heritage - Web applications ==================================== Web application(s) to browse the archive, for both interactive (HTML UI) and mechanized (REST API) use .. toctree:: :maxdepth: 2 :caption: Contents: developers-info uri-scheme-api uri-scheme-browse - uri-scheme-identifiers + uri-scheme-swhids uri-scheme-misc Reference Documentation ----------------------- .. toctree:: :maxdepth: 2 * :ref:`routingtable` diff --git a/docs/uri-scheme-api-identifiers.rst b/docs/uri-scheme-api-swhids.rst similarity index 52% rename from docs/uri-scheme-api-identifiers.rst rename to docs/uri-scheme-api-swhids.rst index 26b7b6a7..9d1882dd 100644 --- 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 index 2a7aa3d8..46188195 100644 --- a/docs/uri-scheme-api.rst +++ b/docs/uri-scheme-api.rst @@ -1,24 +1,24 @@ .. _swh-web-api-urls: swh-web API URLs ================ .. include:: uri-scheme-api-content.rst .. include:: uri-scheme-api-directory.rst .. include:: uri-scheme-api-graph.rst -.. include:: uri-scheme-api-identifiers.rst +.. include:: uri-scheme-api-swhids.rst .. include:: uri-scheme-api-origin.rst .. include:: uri-scheme-api-release.rst .. include:: uri-scheme-api-revision.rst .. include:: uri-scheme-api-snapshot.rst .. include:: uri-scheme-api-stat.rst .. include:: uri-scheme-api-vault.rst diff --git a/docs/uri-scheme-identifiers.rst b/docs/uri-scheme-swhids.rst similarity index 91% rename from docs/uri-scheme-identifiers.rst rename to docs/uri-scheme-swhids.rst index b67d772f..282e5d33 100644 --- a/docs/uri-scheme-identifiers.rst +++ b/docs/uri-scheme-swhids.rst @@ -1,30 +1,30 @@ -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 identifiers are guaranteed to remain stable (persistent) over time. .. http:get:: /(swhid)/ Endpoint to browse Software Heritage objects using their SWHIDs. A redirection to the adequate HTML view will be performed when reaching it. :param string swhid: a SoftWare Heritage persistent IDentifier object, or SWHID (see :ref:`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 :statuscode 400: the provided identifier is malformed **Examples:** .. parsed-literal:: :swh_web:`swh:1:cnt:0ffd12d85cdec70c88e852fc3f5ea9fd342213cd` :swh_web:`swh:1:dir:db990da9af15427455ce7836ce2b8a34b9bf67f5` :swh_web:`swh:1:rel:a9b7e3f1eada90250a6b2ab2ef3e0a846cb16831` :swh_web:`swh:1:rev:f1b94134a4b879bc55c3dacdb496690c8ebdc03f` :swh_web:`swh:1:snp:673156c31a876c5b99b2fe3e89615529de9a3c44`