Update /api/users/general and /api/users/detail to match users-*

pattern used by all other URL routes.
appsembler · Jun 10, 2021 · d09248a · d09248a
1 parent 4380ee8
commit d09248a
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/figures/urls.py b/figures/urls.py
@@ -87,12 +87,12 @@
     base_name='courses-detail')
 
 router.register(
-    r'users/general',
+    r'users-general',
     views.GeneralUserDataViewSet,
     base_name='users-general')
 
 router.register(
-    r'users/detail',
+    r'users-detail',
     views.LearnerDetailsViewSet,
     base_name='users-detail')
 

diff --git a/frontend/src/apiConfig.js b/frontend/src/apiConfig.js
@@ -6,8 +6,8 @@ const apiConfig = {
   generalSiteMetrics: '/figures/api/general-site-metrics/',
   coursesGeneral: '/figures/api/courses-general/',
   coursesDetailed: '/figures/api/courses-detail/',
-  learnersGeneral: '/figures/api/users/general/',
-  learnersDetailed: '/figures/api/users/detail/',
+  learnersGeneral: '/figures/api/users-general/',
+  learnersDetailed: '/figures/api/users-detail/',
   reportingCsvReportsApi: '/reporting/api/csv-reports/',
   coursesIndex: '/figures/api/courses-index/',
   learnerMetrics: '/figures/api/learner-metrics/',

diff --git a/frontend/src/components/course-learners-list/CourseLearnersList.js b/frontend/src/components/course-learners-list/CourseLearnersList.js
@@ -43,7 +43,7 @@ class CourseLearnersList extends Component {
   /** Render the learners list for the course page
 
    API endpoint source of data:
-     figures/api/users/detail/?enrolled_in_course_id=<course-id>
+     figures/api/users-detail/?enrolled_in_course_id=<course-id>
    */
   render() {
 

diff --git a/old-docs/api-reference.md b/old-docs/api-reference.md
@@ -318,7 +318,7 @@ Open edX has different roles, such as, but not limited to learner (or student),
 To get a list of users with summary data:
 
 ```
-/figures/api/users/general/
+/figures/api/users-general/
 ```
 
 ### User Details
@@ -328,25 +328,25 @@ To get a list of users with summary data:
 To get details for all users:
 
 ```
-/figures/api/users/detail/
+/figures/api/users-detail/
 ```
 
 To get details for a specific user, provide the user id:
 
 ```
-/figures/users/detail/10
+/figures/users-detail/10
 ```
 
 To select a set of users, add the `user_ids` query parameter followed by a list of ids:
 
 ```
-/figures/api/users/detail/?user_ids=1,2,3
+/figures/api/users-detail/?user_ids=1,2,3
 ```
 
 To get all the users (learner) enrolled in a course, provide the course id in the `enrolled_in_course_id` query param:
 
 ```
-/fgures/api/users/detail/?enrolled_in_course_id=course-v1:edX+DemoX+Demo_Course
+/fgures/api/users-detail/?enrolled_in_course_id=course-v1:edX+DemoX+Demo_Course
 ```
 
 

diff --git a/tests/views/test_general_user_data_view.py b/tests/views/test_general_user_data_view.py
@@ -124,7 +124,7 @@ class TestGeneralUserViewSet(BaseViewTest):
     """Tests the UserIndexView view class
     """
 
-    request_path = 'api/users/general'
+    request_path = 'api/users-general'
     view_class = GeneralUserDataViewSet
     @pytest.fixture(autouse=True)
     def setup(self, db):

diff --git a/tests/views/test_learner_details_view.py b/tests/views/test_learner_details_view.py
@@ -132,7 +132,7 @@ class TestLearnerDetailsViewSetStandalone(BaseViewTest):
     '''Tests the UserIndexView view class
     '''
 
-    request_path = 'api/users/detail/'
+    request_path = 'api/users-detail/'
     view_class = LearnerDetailsViewSet
     @pytest.fixture(autouse=True)
     def setup(self, db, settings):
@@ -231,7 +231,7 @@ class TestLearnerDetailsViewSetMultisite(BaseViewTest):
     '''Tests the UserIndexView view class
     '''
 
-    request_path = 'api/users/detail/'
+    request_path = 'api/users-detail/'
     view_class = LearnerDetailsViewSet
     @pytest.fixture(autouse=True)
     def setup(self, db, settings):