diff --git a/swh/web/api/views/origin.py b/swh/web/api/views/origin.py --- a/swh/web/api/views/origin.py +++ b/swh/web/api/views/origin.py @@ -163,6 +163,12 @@ Get information about a software origin. + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + Use :http:get:`/api/1/origin/(origin_url)/get/` instead. + :param int origin_id: a software origin identifier {return_origin} @@ -381,6 +387,12 @@ Visits are returned sorted in descending order according to their date. + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + Use :http:get:`/api/1/origin/(origin_url)/visits/` instead. + :param int origin_id: a software origin identifier :query int per_page: specify the number of visits to list, for pagination purposes @@ -498,6 +510,13 @@ Get information about a specific visit of a software origin. + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + Use :http:get:`/api/1/origin/(origin_url)/visit/(visit_id)` + instead. + :param int origin_id: a software origin identifier :param int visit_id: a visit identifier diff --git a/swh/web/api/views/revision.py b/swh/web/api/views/revision.py --- a/swh/web/api/views/revision.py +++ b/swh/web/api/views/revision.py @@ -107,6 +107,16 @@ but operates on the revision that has been found at a given software origin, close to a given point in time, pointed by a given branch. + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + You should instead use successively + :http:get:`/api/1/origin/(origin_url)/visits/`, + :http:get:`/api/1/snapshot/(snapshot_id)/`, and + :http:get:`/api/1/revision/(sha1_git)[/prev/(prev_sha1s)]/log/`. + + :param int origin_id: a software origin identifier :param string branch_name: optional parameter specifying a fully-qualified branch name associated to the software origin, e.g., "refs/heads/master". Defaults to the HEAD branch. @@ -199,6 +209,16 @@ """ Display directory or content information through a revision identified by origin/branch/timestamp. + + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + You should instead use successively + :http:get:`/api/1/origin/(origin_url)/visits/`, + :http:get:`/api/1/snapshot/(snapshot_id)/`, + :http:get:`/api/1/revision/(sha1_git)/`, + :http:get:`/api/1/directory/(sha1_git)/[(path)/]` """ if ts: ts = parse_timestamp(ts) @@ -236,6 +256,15 @@ but operates on the revision that has been found at a given software origin, close to a given point in time, pointed by a given branch. + .. warning:: + + As all endpoints using an ``origin_id``, this endpoint is + deprecated and will be removed in the near future. + You should instead use successively + :http:get:`/api/1/origin/(origin_url)/visits/`, + :http:get:`/api/1/snapshot/(snapshot_id)/`, and + :http:get:`/api/1/revision/(sha1_git)/`. + :param int origin_id: a software origin identifier :param string branch_name: optional parameter specifying a fully-qualified branch name associated to the software origin, e.g., "refs/heads/master". Defaults to the HEAD branch.