From 4ced18769f43f7b7ffe17d648192609afc772eea Mon Sep 17 00:00:00 2001 From: Antoine Lambert <antoine.lambert@inria.fr> Date: Thu, 14 Dec 2017 15:32:28 +0100 Subject: [PATCH] doc: Fix browse URLs in URI scheme description --- docs/uri-scheme-browse.rst | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/docs/uri-scheme-browse.rst b/docs/uri-scheme-browse.rst index 2f5cfaeae..359f9897c 100644 --- a/docs/uri-scheme-browse.rst +++ b/docs/uri-scheme-browse.rst @@ -22,7 +22,6 @@ user URLs: * :http:get:`/browse/content/[(algo_hash):](hash)/`: Display a SWH content * :http:get:`/browse/content/[(algo_hash):](hash)/raw/`: Get / Download SWH content raw data * :http:get:`/browse/directory/(sha1_git)/[(path)/]`: Browse the content of a SWH directory - * :http:get:`/browse/origin/(origin_id)/`: Information on a SWH origin * :http:get:`/browse/person/(person_id)/`: Information on a SWH person * :http:get:`/browse/revision/(sha1_git)/`: Browse a SWH revision * :http:get:`/browse/revision/(sha1_git)/log/`: Browse history log heading to a SWH revision @@ -40,12 +39,10 @@ SWH crawlers. Wherever a revision context is expected in a path (i.e., a **/browse/revision/(sha1_git)/** path fragment) we can put in its stead a path fragment -of the form **/origin/(origin_id)[/visit/(visit_id)/][?branch=(branch)]** or -**/origin/(origin_id)[/ts/(timestamp/][?branch=(branch)]**. Such a -fragment is resolved, internally by the SWH archive, to a *sha1_git* as follows: +of the form **/origin/(origin_type)/url/(origin_url)/[/visit/(timestamp)/][?branch=(branch)]**. +Such a fragment is resolved, internally by the SWH archive, to a *sha1_git* as follows: -- if *timestamp* or *visit_id* is absent: look for the most recent crawl of origin *origin_id* -- if *visit_id* is given: look for crawl with id *visit_id* of origin *origin_id* +- if *timestamp* is absent: look for the most recent crawl of origin *origin_id* - if *timestamp* is given: look for the closest crawl of origin *origin_id* from timestamp *timestamp* - if *branch* is given as a query parameter: look for the branch *branch* @@ -55,15 +52,12 @@ fragment is resolved, internally by the SWH archive, to a *sha1_git* as follows: The already mentioned URLs for revision contexts can therefore be alternatively specified by users as: -* :http:get:`/browse/origin/(origin_id)/directory/[(path)/]` -* :http:get:`/browse/origin/(origin_id)/visit/(visit_id)/directory/[(path)/]` -* :http:get:`/browse/origin/(origin_id)/ts/(timestamp)/directory/[(path)/]` -* :http:get:`/browse/origin/(origin_id)/content/(path)/` -* :http:get:`/browse/origin/(origin_id)/visit/(visit_id)/content/(path)/` -* :http:get:`/browse/origin/(origin_id)/ts/(timestamp)/content/(path)/` -* :http:get:`/browse/origin/(origin_id)/log/` -* :http:get:`/browse/origin/(origin_id)/visit/(visit_id)/log/` -* :http:get:`/browse/origin/(origin_id)/ts/(timestamp)/log/` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/directory/[(path)/]` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/directory/[(path)/]` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/content/(path)/` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/content/(path)/` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/log/` +* :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/log/` Typing: -- GitLab