refactor documentation and names

CenterForOpenScience · Oct 1, 2024 · 44dd395 · 44dd395
1 parent b0288f0
commit 44dd395
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 15 deletions.
diff --git a/api/institutions/serializers.py b/api/institutions/serializers.py
@@ -364,15 +364,6 @@ class NewInstitutionSummaryMetricsSerializer(JSONAPISerializer):
 
     used only when the INSTITUTIONAL_DASHBOARD_2024 feature flag is active
     (and should be renamed without "New" when that flag is permanently active)
-
-    Summary contains counts of
-    - Total users in the institution
-    - Total public project count for the institution
-    - Total private project count for the institution
-    - Total public registration count for the institution
-    - Total private registration count for the institution
-    - Total published preprint count for the institution
-
     '''
 
     class Meta:

diff --git a/api/institutions/urls.py b/api/institutions/urls.py
@@ -13,7 +13,7 @@
     re_path(r'^(?P<institution_id>\w+)/relationships/registrations/$', views.InstitutionRegistrationsRelationship.as_view(), name=views.InstitutionRegistrationsRelationship.view_name),
     re_path(r'^(?P<institution_id>\w+)/relationships/nodes/$', views.InstitutionNodesRelationship.as_view(), name=views.InstitutionNodesRelationship.view_name),
     re_path(r'^(?P<institution_id>\w+)/users/$', views.InstitutionUserList.as_view(), name=views.InstitutionUserList.view_name),
-    re_path(r'^(?P<institution_id>\w+)/metrics/summary/$', views.institution_summary_metrics_list_view, name=views.institution_summary_metrics_list_view.view_name),
+    re_path(r'^(?P<institution_id>\w+)/metrics/summary/$', views.institution_summary_metrics_detail_view, name=views.institution_summary_metrics_detail_view.view_name),
     re_path(r'^(?P<institution_id>\w+)/metrics/departments/$', views.InstitutionDepartmentList.as_view(), name=views.InstitutionDepartmentList.view_name),
     re_path(r'^(?P<institution_id>\w+)/metrics/users/$', views.institution_user_metrics_list_view, name=views.institution_user_metrics_list_view.view_name),
 ]
diff --git a/api/institutions/views.py b/api/institutions/views.py
@@ -582,8 +582,8 @@ def get_default_search(self):
         )
 
 
-class _NewInstitutionSummaryMetricsList(JSONAPIBaseView, generics.RetrieveAPIView, InstitutionMixin):
-    '''list view for institution-summary metrics
+class _NewInstitutionSummaryMetricsDetail(JSONAPIBaseView, generics.RetrieveAPIView, InstitutionMixin):
+    '''detail view for institution-summary metrics
 
     used only when the INSTITUTIONAL_DASHBOARD_2024 feature flag is active
     (and should be renamed without "New" when that flag is permanently active)
@@ -621,12 +621,12 @@ def get_default_search(self):
         )
 
 
-institution_summary_metrics_list_view = toggle_view_by_flag(
+institution_summary_metrics_detail_view = toggle_view_by_flag(
     flag_name=osf.features.INSTITUTIONAL_DASHBOARD_2024,
     old_view=_OldInstitutionSummaryMetrics.as_view(),
-    new_view=_NewInstitutionSummaryMetricsList.as_view(),
+    new_view=_NewInstitutionSummaryMetricsDetail.as_view(),
 )
-institution_summary_metrics_list_view.view_name = 'institution-summary-metrics'
+institution_summary_metrics_detail_view.view_name = 'institution-summary-metrics'
 
 
 institution_user_metrics_list_view = toggle_view_by_flag(