From 60b13b18e39613558479e70e02210e5c12a24ddb Mon Sep 17 00:00:00 2001 From: Tristan Cacqueray Date: Fri, 3 May 2019 03:48:49 +0000 Subject: [PATCH] Add APIRoot index This change adds a welcoming index to the root path so that users can navigate the api without knowning the path instead of being given a 404. Change-Id: If865e3c4ee7e6fa633c74152d6579b94ea75be4a --- ara/server/urls.py | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/ara/server/urls.py b/ara/server/urls.py index 3cb8dfd5..b73fe08e 100644 --- a/ara/server/urls.py +++ b/ara/server/urls.py @@ -15,7 +15,32 @@ # You should have received a copy of the GNU General Public License # along with ARA. If not, see . +import urllib.parse + +import pbr from django.contrib import admin from django.urls import include, path +from rest_framework.response import Response +from rest_framework.views import APIView -urlpatterns = [path("api/v1/", include("ara.api.urls")), path("admin/", admin.site.urls)] + +# fmt: off +class APIRoot(APIView): + def get(self, request): + return Response({ + "kind": "ara", + "version": pbr.version.VersionInfo("ara").release_string(), + "api": list(map(lambda x: urllib.parse.urljoin( + request.build_absolute_uri(), x), + [ + "api/v1/", + ])) + }) + + +urlpatterns = [ + path("", APIRoot.as_view()), + path("api/v1/", include("ara.api.urls")), + path("admin/", admin.site.urls), +] +# fmt: on