deposit.api: Add a basic api page to avoid broken link

Related to T2140

swh/deposit/api/urls.py

-# Copyright (C) 2017-2018  The Software Heritage developers
+# Copyright (C) 2017-2019  The Software Heritage developers
 # See the AUTHORS file at the top-level directory of this distribution
 # License: GNU General Public License version 3, or any later version
 # See top-level LICENSE file for more information
 
-"""swh URL Configuration
+"""SWH's deposit api URL Configuration
 
 """
 
 from django.conf.urls import url
+from django.shortcuts import render
 
 from ..config import EDIT_SE_IRI, EM_IRI, CONT_FILE_IRI
 from ..config import SD_IRI, COL_IRI, STATE_IRI
@@ -18,9 +19,15 @@ from .deposit_update import SWHUpdateArchiveDeposit
 from .deposit_content import SWHDepositContent
 from .service_document import SWHServiceDocument
 
-urlpatterns = [
-    # PUBLIC API
 
+def api_view(req):
+    return render(req, "api.html")
+
+
+# PUBLIC API
+urlpatterns = [
+    # simple view on the api
+    url(r'^$', api_view, name='api'),
     # SD IRI - Service Document IRI
     # -> GET
     url(r'^servicedocument/', SWHServiceDocument.as_view(),

swh/deposit/templates/api.html

+{% extends "layout.html" %}
+{% load static %}
+{% block title %}The Software Heritage Deposit Api{% endblock %}
+
+{% block content %}
+
+<h2>Documentation</h2>
+
+<p>
+  <ul>
+    <li><a href="https://docs.softwareheritage.org/devel/swh-deposit">Index</a></li>
+    <li><a href="https://docs.softwareheritage.org/devel/swh-deposit/getting-started.html">Getting Started</a></li>
+    <li><a href="https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html">Specification</a></li>
+  </ul>
+</p>
+
+{% endblock %}

[Phabricator Migration user]

Some references in the commit message have been migrated:

• T2140 is now #2140 (closed)