openapi

aaxelb · Feb 29, 2024 · da28de7 · da28de7
1 parent d3102f9
commit da28de7
Show file tree

Hide file tree

Showing 4 changed files with 475 additions and 1 deletion.
diff --git a/api/metrics/urls.py b/api/metrics/urls.py
@@ -1,4 +1,4 @@
-from django.conf.urls import re_path
+from django.urls import re_path, path
 
 from . import views
 
@@ -40,4 +40,5 @@
         views.UniqueUserVisitsQuery.as_view(),
         name=views.UniqueUserVisitsQuery.view_name,
     ),
+    path('openapi.json', views.metrics_openapi_view, name='openapi'),
 ]
diff --git a/api/metrics/views.py b/api/metrics/views.py
@@ -55,6 +55,7 @@
     RegistriesModerationMetrics,
     CountedAuthUsage,
 )
+from osf.metrics.openapi import get_metrics_openapi_json_dict
 from osf.models import AbstractNode
 
 
@@ -633,3 +634,8 @@ def _build_query_payload(self, timespan):
         payload = super()._build_query_payload(timespan)
         payload['query']['bool']['filter'].insert(0, {'term': {'user_is_authenticated': True}})
         return payload
+
+
+def metrics_openapi_view(request):
+    _openapi_json = get_metrics_openapi_json_dict(reports=VIEWABLE_REPORTS)
+    return JsonResponse(_openapi_json, json_dumps_params={'indent': 2})