Changeset View
Changeset View
Standalone View
Standalone View
docs/uri-scheme-browse-origin.rst
Show First 20 Lines • Show All 85 Lines • ▼ Show 20 Lines | .. http:get:: /browse/origin/directory/ | ||||
:query string path: optional parameter used to specify the path of a directory | :query string path: optional parameter used to specify the path of a directory | ||||
reachable from the origin root one | reachable from the origin root one | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the root directory | to retrieve the root directory | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the root directory | to retrieve the root directory | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the root directory | representation of its **sha1_git** value, from which to retrieve the root directory | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:query int visit_id: specify a visit id to retrieve the directory from instead | :query int visit_id: specify a visit id to retrieve the directory from instead | ||||
of using the latest full visit by default | of using the latest full visit by default | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
or the provided path does not exist from the origin root directory | or the provided path does not exist from the origin root directory | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux×tamp=1493926809` | |||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet×tamp=2016-09-14T10:36:21Z` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet×tamp=2016-09-14T10:36:21Z` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython×tamp=1474620651` | |||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python×tamp=2017-05-05` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python×tamp=2017-05-05` | ||||
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7×tamp=2015-08` | :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7×tamp=2015-08` | ||||
.. http:get:: /browse/origin/(origin_url)/directory/[(path)/] | .. http:get:: /browse/origin/(origin_url)/directory/[(path)/] | ||||
:deprecated: | :deprecated: | ||||
.. warning:: | .. warning:: | ||||
▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Lines | :deprecated: | ||||
The view also enables to easily switch between the origin branches | The view also enables to easily switch between the origin branches | ||||
and releases through a dropdown menu. | and releases through a dropdown menu. | ||||
The origin branch (default to HEAD) from which to retrieve the directory | The origin branch (default to HEAD) from which to retrieve the directory | ||||
content can also be specified by using the branch query parameter. | content can also be specified by using the branch query parameter. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :param string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:param path: optional parameter used to specify the path of a directory | :param path: optional parameter used to specify the path of a directory | ||||
reachable from the origin root one | reachable from the origin root one | ||||
:type path: string | :type path: string | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the root directory | to retrieve the root directory | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the root directory | to retrieve the root directory | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
▲ Show 20 Lines • Show All 49 Lines • ▼ Show 20 Lines | :query string origin_url: mandatory parameter providing the url of the origin | ||||
(e.g. https://github.com/(user)/(repo)) | (e.g. https://github.com/(user)/(repo)) | ||||
:query string path: path of a content reachable from the origin root directory | :query string path: path of a content reachable from the origin root directory | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the content | representation of its **sha1_git** value, from which to retrieve the content | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:query int visit_id: specify a visit id to retrieve the content from instead | :query int visit_id: specify a visit id to retrieve the content from instead | ||||
of using the latest full visit by default | of using the latest full visit by default | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive, | :statuscode 404: requested origin can not be found in the archive, | ||||
or the provided content path does not exist from the origin root directory | or the provided content path does not exist from the origin root directory | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c` | :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c` | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp` | :swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp` | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c&branch=refs/heads/next` | :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c&branch=refs/heads/next` | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c×tamp=1473933564` | |||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c×tamp=2016-05-05T00:0:00+00:00Z` | :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c×tamp=2016-05-05T00:0:00+00:00Z` | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp×tamp=1490126182` | |||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp×tamp=2017-03-21#L904-L931` | :swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp×tamp=2017-03-21#L904-L931` | ||||
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&branch=refs/heads/next×tamp=2017-09-15` | :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&branch=refs/heads/next×tamp=2017-09-15` | ||||
.. http:get:: /browse/origin/(origin_url)/content/ | .. http:get:: /browse/origin/(origin_url)/content/ | ||||
:deprecated: | :deprecated: | ||||
.. warning:: | .. warning:: | ||||
Show All 26 Lines | :deprecated: | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:query string path: path of a content reachable from the origin root directory | :query string path: path of a content reachable from the origin root directory | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the content | representation of its **sha1_git** value, from which to retrieve the content | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:query int visit_id: specify a visit id to retrieve the content from instead | :query int visit_id: specify a visit id to retrieve the content from instead | ||||
of using the latest full visit by default | of using the latest full visit by default | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive, | :statuscode 404: requested origin can not be found in the archive, | ||||
or the provided content path does not exist from the origin root directory | or the provided content path does not exist from the origin root directory | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c` | :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c` | ||||
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content/?path=js/src/json.cpp` | :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content/?path=js/src/json.cpp` | ||||
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&branch=refs/heads/next` | :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&branch=refs/heads/next` | ||||
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c×tamp=1473933564` | |||||
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c×tamp=2016-05-05T00:0:00+00:00Z` | :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c×tamp=2016-05-05T00:0:00+00:00Z` | ||||
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp×tamp=1490126182` | |||||
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp×tamp=2017-03-21#L904-L931` | :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp×tamp=2017-03-21#L904-L931` | ||||
:swh_web_browse:`origin/https://github.com/git/git/content/git.c/?branch=refs/heads/next×tamp=2017-09-15` | :swh_web_browse:`origin/https://github.com/git/git/content/git.c/?branch=refs/heads/next×tamp=2017-09-15` | ||||
.. http:get:: /browse/origin/(origin_url)/content/(path)/ | .. http:get:: /browse/origin/(origin_url)/content/(path)/ | ||||
:deprecated: | :deprecated: | ||||
.. warning:: | .. warning:: | ||||
▲ Show 20 Lines • Show All 73 Lines • ▼ Show 20 Lines | :deprecated: | ||||
The view also enables to easily switch between the origin branches | The view also enables to easily switch between the origin branches | ||||
and releases through a dropdown menu. | and releases through a dropdown menu. | ||||
The origin branch (default to HEAD) from which to retrieve the content | The origin branch (default to HEAD) from which to retrieve the content | ||||
can also be specified by using the branch query parameter. | can also be specified by using the branch query parameter. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :param string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:param string path: path of a content reachable from the origin root directory | :param string path: path of a content reachable from the origin root directory | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the content | to retrieve the content | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the content | representation of its **sha1_git** value, from which to retrieve the content | ||||
:query int visit_id: specify a visit id to retrieve the content from instead | :query int visit_id: specify a visit id to retrieve the content from instead | ||||
of using the provided timestamp | of using the provided timestamp | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive, | :statuscode 404: requested origin can not be found in the archive, | ||||
requested visit timestamp does not exist or the provided content path does | requested visit timestamp does not exist or the provided content path does | ||||
not exist from the origin root directory | not exist from the origin root directory | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/git/git/visit/1473933564/content/git.c/` | |||||
:swh_web_browse:`origin/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00Z/content/git.c/` | :swh_web_browse:`origin/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00Z/content/git.c/` | ||||
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/1490126182/content/js/src/json.cpp/` | |||||
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931` | :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931` | ||||
:swh_web_browse:`origin/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next` | :swh_web_browse:`origin/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next` | ||||
Origin history | Origin history | ||||
"""""""""""""" | """""""""""""" | ||||
.. http:get:: /browse/origin/log/ | .. http:get:: /browse/origin/log/ | ||||
Show All 35 Lines | .. http:get:: /browse/origin/log/ | ||||
:query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, | :query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, | ||||
``dfs``, ``dfs_post`` and ``bfs`` | ``dfs``, ``dfs_post`` and ``bfs`` | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the commit log | representation of its **sha1_git** value, from which to retrieve the commit log | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:query int visit_id: specify a visit id to retrieve the history log from instead | :query int visit_id: specify a visit id to retrieve the history log from instead | ||||
of using the latest visit by default | of using the latest visit by default | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines | :deprecated: | ||||
:query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, | :query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, | ||||
``dfs``, ``dfs_post`` and ``bfs`` | ``dfs``, ``dfs_post`` and ``bfs`` | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the commit log | representation of its **sha1_git** value, from which to retrieve the commit log | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:query int visit_id: specify a visit id to retrieve the history log from instead | :query int visit_id: specify a visit id to retrieve the history log from instead | ||||
of using the latest visit by default | of using the latest visit by default | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/videolan/vlc/log/` | :swh_web_browse:`origin/https://github.com/videolan/vlc/log/` | ||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/` | ||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release` | ||||
:swh_web_browse:`origin/https://github.com/videolan/vlc/log/?visit=1459651262` | |||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?timestamp=2016-04-01` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?timestamp=2016-04-01` | ||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release×tamp=1438116814` | |||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release×tamp=2017-05-05T03:14:23Z` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release×tamp=2017-05-05T03:14:23Z` | ||||
.. http:get:: /browse/origin/(origin_url)/visit/(timestamp)/log/ | .. http:get:: /browse/origin/(origin_url)/visit/(timestamp)/log/ | ||||
:deprecated: | :deprecated: | ||||
.. warning:: | .. warning:: | ||||
That endpoint is deprecated, use :http:get:`/browse/origin/log/` instead. | That endpoint is deprecated, use :http:get:`/browse/origin/log/` instead. | ||||
Show All 22 Lines | :deprecated: | ||||
The view also enables to easily switch between the origin branches | The view also enables to easily switch between the origin branches | ||||
and releases through a dropdown menu. | and releases through a dropdown menu. | ||||
The origin branch (default to HEAD) from which to retrieve the content | The origin branch (default to HEAD) from which to retrieve the content | ||||
can also be specified by using the branch query parameter. | can also be specified by using the branch query parameter. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :param string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
: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 | ||||
(default is 20, max is 50) | (default is 20, max is 50) | ||||
:query string branch: specify the origin branch name from which | :query string branch: specify the origin branch name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string release: specify the origin release name from which | :query string release: specify the origin release name from which | ||||
to retrieve the commit log | to retrieve the commit log | ||||
:query string revision: specify the origin revision, identified by the hexadecimal | :query string revision: specify the origin revision, identified by the hexadecimal | ||||
representation of its **sha1_git** value, from which to retrieve the commit log | representation of its **sha1_git** value, from which to retrieve the commit log | ||||
:query int visit_id: specify a visit id to retrieve the history log from instead | :query int visit_id: specify a visit id to retrieve the history log from instead | ||||
of using the provided timestamp | of using the provided timestamp | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/videolan/vlc/visit/1459651262/log/` | |||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-04-01/log/` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-04-01/log/` | ||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/1438116814/log/?branch=refs/heads/release` | |||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23Z/log/?branch=refs/heads/release` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23Z/log/?branch=refs/heads/release` | ||||
Origin branches | Origin branches | ||||
""""""""""""""" | """"""""""""""" | ||||
.. http:get:: /browse/origin/branches/ | .. http:get:: /browse/origin/branches/ | ||||
HTML view that produces a display of the list of branches | HTML view that produces a display of the list of branches | ||||
found during the latest full visit of a software origin. | found during the latest full visit of a software origin. | ||||
The following data are displayed for each branch: | The following data are displayed for each branch: | ||||
* its name | * its name | ||||
* a link to browse the associated directory | * a link to browse the associated directory | ||||
* a link to browse the associated revision | * a link to browse the associated revision | ||||
* last commit message | * last commit message | ||||
* last commit date | * last commit date | ||||
That list of branches is paginated, each page displaying a maximum of 100 branches. | That list of branches is paginated, each page displaying a maximum of 100 branches. | ||||
:query string origin_url: mandatory parameter providing the url of the origin | :query string origin_url: mandatory parameter providing the url of the origin | ||||
(e.g. https://github.com/(user)/(repo)) | (e.g. https://github.com/(user)/(repo)) | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
Show All 18 Lines | The following data are displayed for each branch: | ||||
* a link to browse the associated directory | * a link to browse the associated directory | ||||
* a link to browse the associated revision | * a link to browse the associated revision | ||||
* last commit message | * last commit message | ||||
* last commit date | * last commit date | ||||
That list of branches is paginated, each page displaying a maximum of 100 branches. | That list of branches is paginated, each page displaying a maximum of 100 branches. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/deb://Debian/packages/linux/branches/` | :swh_web_browse:`origin/deb://Debian/packages/linux/branches/` | ||||
Show All 17 Lines | The following data are displayed for each branch: | ||||
* a link to browse the associated directory | * a link to browse the associated directory | ||||
* a link to browse the associated revision | * a link to browse the associated revision | ||||
* last commit message | * last commit message | ||||
* last commit date | * last commit date | ||||
That list of branches is paginated, each page displaying a maximum of 100 branches. | That list of branches is paginated, each page displaying a maximum of 100 branches. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :param string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03Z/branches/` | :swh_web_browse:`origin/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03Z/branches/` | ||||
Show All 14 Lines | The following data are displayed for each release: | ||||
* its target type (revision, directory, content or release) | * its target type (revision, directory, content or release) | ||||
* its associated message | * its associated message | ||||
* its date | * its date | ||||
That list of releases is paginated, each page displaying a maximum of 100 releases. | That list of releases is paginated, each page displaying a maximum of 100 releases. | ||||
:query string origin_url: mandatory parameter providing the url of the origin | :query string origin_url: mandatory parameter providing the url of the origin | ||||
(e.g. https://github.com/(user)/(repo)) | (e.g. https://github.com/(user)/(repo)) | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 400: no origin url has been provided as parameter | :statuscode 400: no origin url has been provided as parameter | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
Show All 18 Lines | The following data are displayed for each release: | ||||
* a link to browse the release details | * a link to browse the release details | ||||
* its target type (revision, directory, content or release) | * its target type (revision, directory, content or release) | ||||
* its associated message | * its associated message | ||||
* its date | * its date | ||||
That list of releases is paginated, each page displaying a maximum of 100 releases. | That list of releases is paginated, each page displaying a maximum of 100 releases. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :query string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/git/git/releases/` | :swh_web_browse:`origin/https://github.com/git/git/releases/` | ||||
Show All 17 Lines | The following data are displayed for each release: | ||||
* a link to browse the release details | * a link to browse the release details | ||||
* its target type (revision, directory, content or release) | * its target type (revision, directory, content or release) | ||||
* its associated message | * its associated message | ||||
* its date | * its date | ||||
That list of releases is paginated, each page displaying a maximum of 100 releases. | That list of releases is paginated, each page displaying a maximum of 100 releases. | ||||
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) | ||||
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) | :param string timestamp: an ISO 8601 datetime string to parse in order to find the | ||||
or Unix timestamp to parse in order to find the closest visit. | closest visit. | ||||
:statuscode 200: no error | :statuscode 200: no error | ||||
:statuscode 404: requested origin can not be found in the archive | :statuscode 404: requested origin can not be found in the archive | ||||
**Examples:** | **Examples:** | ||||
.. parsed-literal:: | .. parsed-literal:: | ||||
:swh_web_browse:`origin/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42Z/releases/` | :swh_web_browse:`origin/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42Z/releases/` | ||||
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35Z/releases/` | :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35Z/releases/` | ||||
.. _highlightjs: https://highlightjs.org/ | .. _highlightjs: https://highlightjs.org/ | ||||
.. _dateutil.parser.parse: http://dateutil.readthedocs.io/en/stable/parser.html |