Changeset View
Changeset View
Standalone View
Standalone View
docs/uri-scheme-browse-snapshot.rst
| Show All 36 Lines | |||||
| .. http:get:: /browse/snapshot/(snapshot_id)/directory/[(path)/] | .. http:get:: /browse/snapshot/(snapshot_id)/directory/[(path)/] | ||||
| HTML view that displays the content of a directory reachable from | HTML view that displays the content of a directory reachable from | ||||
| a snapshot. | a snapshot. | ||||
| The features offered by the view are similar to the one for browsing | The features offered by the view are similar to the one for browsing | ||||
| a directory in an origin context | a directory in an origin context | ||||
| (see :http:get:`/browse/origin/[(origin_type)/url/](origin_url)/directory/[(path)/]`). | (see :http:get:`/browse/origin/(origin_url)/directory/[(path)/]`). | ||||
| :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | ||||
| :param string path: optional parameter used to specify the path of a directory | :param string path: optional parameter used to specify the path of a directory | ||||
| reachable from the snapshot root one | reachable from the snapshot root one | ||||
| :query string branch: specify the snapshot branch name from which | :query string branch: specify the snapshot branch name from which | ||||
| to retrieve the root directory | to retrieve the root directory | ||||
| :query string release: specify the snapshot release name from which | :query string release: specify the snapshot release name from which | ||||
| to retrieve the root directory | to retrieve the root directory | ||||
| Show All 17 Lines | |||||
| .. http:get:: /browse/snapshot/(snapshot_id)/content/(path)/ | .. http:get:: /browse/snapshot/(snapshot_id)/content/(path)/ | ||||
| HTML view that produces a display of a content reachable from | HTML view that produces a display of a content reachable from | ||||
| a snapshot. | a snapshot. | ||||
| The features offered by the view are similar to the one for browsing | The features offered by the view are similar to the one for browsing | ||||
| a content in an origin context | a content in an origin context | ||||
| (see :http:get:`/browse/origin/[(origin_type)/url/](origin_url)/content/(path)/`). | (see :http:get:`/browse/origin/(origin_url)/content/(path)/`). | ||||
| :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | ||||
| :param string path: path of a content reachable from the snapshot root directory | :param string path: path of a content reachable from the snapshot root directory | ||||
| :query string branch: specify the snapshot branch name from which | :query string branch: specify the snapshot branch name from which | ||||
| to retrieve the content | to retrieve the content | ||||
| :query string release: specify the snapshot release name from which | :query string release: specify the snapshot release name from which | ||||
| to retrieve the content | to retrieve the content | ||||
| :query string revision: specify the snapshot revision, identified by the hexadecimal | :query string revision: specify the snapshot revision, identified by the hexadecimal | ||||
| Show All 17 Lines | |||||
| .. http:get:: /browse/snapshot/(snapshot_id)/log/ | .. http:get:: /browse/snapshot/(snapshot_id)/log/ | ||||
| HTML view that produces a display of revisions history (aka the commit log) | HTML view that produces a display of revisions history (aka the commit log) | ||||
| heading to the last revision collected in a snapshot. | heading to the last revision collected in a snapshot. | ||||
| The features offered by the view are similar to the one for browsing | The features offered by the view are similar to the one for browsing | ||||
| the history in an origin context | the history in an origin context | ||||
| (see :http:get:`/browse/origin/[(origin_type)/url/](origin_url)/log/`). | (see :http:get:`/browse/origin/(origin_url)/log/`). | ||||
| :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | ||||
| :query string revs_breadcrumb: used internally to store | :query string revs_breadcrumb: used internally to store | ||||
| the navigation breadcrumbs (i.e. the list of descendant revisions | the navigation breadcrumbs (i.e. the list of descendant revisions | ||||
| visited so far). It must be a string in the form | visited so far). It must be a string in the form | ||||
| "(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a | "(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a | ||||
| revision **sha1_git**. | revision **sha1_git**. | ||||
| :query int per_page: the number of log entries to display per page | :query int per_page: the number of log entries to display per page | ||||
| Show All 21 Lines | |||||
| .. http:get:: /browse/snapshot/(snapshot_id)/branches/ | .. http:get:: /browse/snapshot/(snapshot_id)/branches/ | ||||
| HTML view that produces a display of the list of branches | HTML view that produces a display of the list of branches | ||||
| collected in a snapshot. | collected in a snapshot. | ||||
| The features offered by the view are similar to the one for browsing | The features offered by the view are similar to the one for browsing | ||||
| the list of branches in an origin context | the list of branches in an origin context | ||||
| (see :http:get:`/browse/origin/[(origin_type)/url/](origin_url)/branches/`). | (see :http:get:`/browse/origin/(origin_url)/branches/`). | ||||
| :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | ||||
| :statuscode 200: no error | :statuscode 200: no error | ||||
| :statuscode 400: an invalid snapshot identifier has been provided | :statuscode 400: an invalid snapshot identifier has been provided | ||||
| :statuscode 404: requested snapshot can not be found in the archive | :statuscode 404: requested snapshot can not be found in the archive | ||||
| **Examples:** | **Examples:** | ||||
| .. parsed-literal:: | .. parsed-literal:: | ||||
| :swh_web_browse:`snapshot/03d7897352541e78ee7b13a580dc836778e8126a/branches/` | :swh_web_browse:`snapshot/03d7897352541e78ee7b13a580dc836778e8126a/branches/` | ||||
| :swh_web_browse:`snapshot/f37563b953327f8fd83e39af6ebb929ef85103d5/branches/` | :swh_web_browse:`snapshot/f37563b953327f8fd83e39af6ebb929ef85103d5/branches/` | ||||
| Snapshot releases | Snapshot releases | ||||
| """"""""""""""""" | """"""""""""""""" | ||||
| .. http:get:: /browse/snapshot/(snapshot_id)/releases/ | .. http:get:: /browse/snapshot/(snapshot_id)/releases/ | ||||
| HTML view that produces a display of the list of releases | HTML view that produces a display of the list of releases | ||||
| collected in a snapshot. | collected in a snapshot. | ||||
| The features offered by the view are similar to the one for browsing | The features offered by the view are similar to the one for browsing | ||||
| the list of releases in an origin context | the list of releases in an origin context | ||||
| (see :http:get:`/browse/origin/[(origin_type)/url/](origin_url)/releases/`). | (see :http:get:`/browse/origin/(origin_url)/releases/`). | ||||
| :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | :param string snapshot_id: hexadecimal representation of the snapshot **sha1** identifier | ||||
| :statuscode 200: no error | :statuscode 200: no error | ||||
| :statuscode 400: an invalid snapshot identifier has been provided | :statuscode 400: an invalid snapshot identifier has been provided | ||||
| :statuscode 404: requested snapshot can not be found in the archive | :statuscode 404: requested snapshot can not be found in the archive | ||||
| **Examples:** | **Examples:** | ||||
| .. parsed-literal:: | .. parsed-literal:: | ||||
| :swh_web_browse:`snapshot/673156c31a876c5b99b2fe3e89615529de9a3c44/releases/` | :swh_web_browse:`snapshot/673156c31a876c5b99b2fe3e89615529de9a3c44/releases/` | ||||
| :swh_web_browse:`snapshot/23e6fb084a60cc909b9e222d80d89fdb98756dee/releases/` | :swh_web_browse:`snapshot/23e6fb084a60cc909b9e222d80d89fdb98756dee/releases/` | ||||