diff --git a/swh/web/api/apidoc.py b/swh/web/api/apidoc.py --- a/swh/web/api/apidoc.py +++ b/swh/web/api/apidoc.py @@ -330,6 +330,7 @@ * hidden: remove the entry points from the listing * upcoming: display the entry point but it is not followable + * deprecated: display the entry point as deprecated in the index api_version: api version string """ diff --git a/swh/web/api/views/vault.py b/swh/web/api/views/vault.py --- a/swh/web/api/views/vault.py +++ b/swh/web/api/views/vault.py @@ -138,7 +138,7 @@ throttle_scope="swh_vault_cooking", never_cache=True, ) -@api_doc("/vault/directory/", tags=["hidden"]) +@api_doc("/vault/directory/", tags=["deprecated"]) @format_docstring() def api_vault_cook_directory(request, dir_id): """ @@ -198,7 +198,7 @@ "api-1-vault-fetch-directory", checksum_args=["dir_id"], ) -@api_doc("/vault/directory/raw/", tags=["hidden"]) +@api_doc("/vault/directory/raw/", tags=["hidden", "deprecated"]) def api_vault_fetch_directory(request, dir_id): """ .. http:get:: /api/1/vault/directory/(dir_id)/raw/ @@ -225,7 +225,7 @@ throttle_scope="swh_vault_cooking", never_cache=True, ) -@api_doc("/vault/gitfast/", tags=["hidden"]) +@api_doc("/vault/gitfast/") @format_docstring() def api_vault_cook_gitfast(request, swhid): """ @@ -300,7 +300,7 @@ throttle_scope="swh_vault_cooking", never_cache=True, ) -@api_doc("/vault/revision/gitfast/", tags=["hidden"]) +@api_doc("/vault/revision/gitfast/", tags=["deprecated"]) @format_docstring() def api_vault_cook_revision_gitfast(request, rev_id): """ @@ -360,7 +360,7 @@ "api-1-vault-fetch-revision_gitfast", checksum_args=["rev_id"], ) -@api_doc("/vault/revision_gitfast/raw/", tags=["hidden"]) +@api_doc("/vault/revision_gitfast/raw/", tags=["hidden", "deprecated"]) def _api_vault_revision_gitfast_raw(request, rev_id): """ .. http:get:: /api/1/vault/revision/(rev_id)/gitfast/raw/ diff --git a/swh/web/templates/api/endpoints.html b/swh/web/templates/api/endpoints.html --- a/swh/web/templates/api/endpoints.html +++ b/swh/web/templates/api/endpoints.html @@ -46,7 +46,7 @@ {% for route, doc in doc_routes %} - {% if doc.tags|length > 0 %} + {% if "upcoming" in doc.tags %} {% url doc.route_view_name %} @@ -55,6 +55,7 @@ {{ doc.route }} + {% if "deprecated" in doc.tags %}(deprecated){% endif %} {% endif %}