diff --git a/swh/deposit/api/urls.py b/swh/deposit/api/urls.py --- a/swh/deposit/api/urls.py +++ b/swh/deposit/api/urls.py @@ -1,13 +1,14 @@ -# 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_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(), diff --git a/swh/deposit/templates/api.html b/swh/deposit/templates/api.html new file mode 100644 --- /dev/null +++ b/swh/deposit/templates/api.html @@ -0,0 +1,17 @@ +{% extends "layout.html" %} +{% load static %} +{% block title %}The Software Heritage Deposit Api{% endblock %} + +{% block content %} + +

Documentation

+ +

+

+

+ +{% endblock %} diff --git a/swh/deposit/templates/homepage.html b/swh/deposit/templates/homepage.html --- a/swh/deposit/templates/homepage.html +++ b/swh/deposit/templates/homepage.html @@ -25,12 +25,9 @@ Deposit) is an interoperability standard for digital file deposit. -This implementation will permit interaction between a client (a -repository, e.g. hal) and a server -(SWH repository) to -permit deposits of software source code archives with associated -metadata. - +This implementation allows a client (a repository, e.g. hal) to deposit +software source archives and its associated metadata to the (SWH archive).

Documentation

diff --git a/swh/deposit/urls.py b/swh/deposit/urls.py --- a/swh/deposit/urls.py +++ b/swh/deposit/urls.py @@ -1,9 +1,9 @@ -# 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 -"""swhdeposit URL Configuration +"""SWH's main deposit URL Configuration """