Fix swagger paths (#991)

* Fix SourcecastController Swagger paths

* Fix AssessmentsController Swagger paths

* Fix NotificationsController Swagger paths

Removes the v2 prefix that is already in the base URL.

* Fix StoriesController Swagger paths

Removes the v2 prefix that is already in the base URL.

* Fix AdminUserController Swagger paths

* Removes the v2 prefix that is already in the base URL
* Fix incorrect names and paths

* Fix AdminAchievementsController Swagger paths

* Fix AdminStoriesController Swagger paths

* Fix CoursesController Swagger paths

* Removes the v2 prefix that is already in the base URL
* Fix incorrect names and paths

* Fix IncentivesController Swagger paths

* Group incentives-related routes together

* Fix AdminAssessmentsController Swagger paths

Also added a FIXME for a missing corresponding Swagger path entry for a
route.

* Fix AdminAssetsController Swagger paths

* Fix AdminCoursesController Swagger paths

Also added FIXMEs for missing entries.

* Fix AdminGradingController Swagger paths

* Fix credo error

Renamed FIXMEs to TODOs.

* Update tests

lib/cadet_web/admin_controllers/admin_achievements_controller.ex

@@ -61,7 +61,7 @@ defmodule CadetWeb.AdminAchievementsController do
   end
 
   swagger_path :update do
-    put("/admin/achievements/{uuid}")
+    put("/courses/{course_id}/admin/achievements/{uuid}")
 
     summary("Inserts or updates an achievement")
 
@@ -87,7 +87,7 @@ defmodule CadetWeb.AdminAchievementsController do
   end
 
   swagger_path :bulk_update do
-    put("/admin/achievements")
+    put("/courses/{course_id}/admin/achievements")
 
     summary("Inserts or updates achievements")
 
@@ -108,7 +108,7 @@ defmodule CadetWeb.AdminAchievementsController do
   end
 
   swagger_path :delete do
-    PhoenixSwagger.Path.delete("/admin/achievements/{uuid}")
+    PhoenixSwagger.Path.delete("/courses/{course_id}/admin/achievements/{uuid}")
 
     summary("Deletes an achievement")
     security([%{JWT: []}])

lib/cadet_web/admin_controllers/admin_assessments_controller.ex

@@ -127,7 +127,7 @@ defmodule CadetWeb.AdminAssessmentsController do
   end
 
   swagger_path :index do
-    get("/admin/users/{courseRegId}/assessments")
+    get("/courses/{course_id}/admin/users/{courseRegId}/assessments")
 
     summary("Fetches assessment overviews of a user")
 
@@ -143,7 +143,7 @@ defmodule CadetWeb.AdminAssessmentsController do
   end
 
   swagger_path :create do
-    post("/admin/assessments")
+    post("/courses/{course_id}/admin/assessments")
 
     summary("Creates a new assessment or updates an existing assessment")
 
@@ -162,7 +162,7 @@ defmodule CadetWeb.AdminAssessmentsController do
   end
 
   swagger_path :delete do
-    PhoenixSwagger.Path.delete("/admin/assessments/{assessmentId}")
+    PhoenixSwagger.Path.delete("/courses/{course_id}/admin/assessments/{assessmentId}")
 
     summary("Deletes an assessment")
 
@@ -177,7 +177,7 @@ defmodule CadetWeb.AdminAssessmentsController do
   end
 
   swagger_path :update do
-    post("/admin/assessments/{assessmentId}")
+    post("/courses/{course_id}/admin/assessments/{assessmentId}")
 
     summary("Updates an assessment")
 

lib/cadet_web/admin_controllers/admin_assets_controller.ex

@@ -71,7 +71,7 @@ defmodule CadetWeb.AdminAssetsController do
   end
 
   swagger_path :index do
-    get("/admin/assets/{folderName}")
+    get("/courses/{course_id}/admin/assets/{folderName}")
 
     summary("Get a list of all assets in a folder")
 
@@ -89,7 +89,7 @@ defmodule CadetWeb.AdminAssetsController do
   end
 
   swagger_path :delete do
-    PhoenixSwagger.Path.delete("/admin/assets/{folderName}/{fileName}")
+    PhoenixSwagger.Path.delete("/courses/{course_id}/admin/assets/{folderName}/{fileName}")
 
     summary("Delete a file from an asset folder")
 
@@ -108,7 +108,7 @@ defmodule CadetWeb.AdminAssetsController do
   end
 
   swagger_path :upload do
-    post("/admin/assets/{folderName}/{fileName}")
+    post("/courses/{course_id}/admin/assets/{folderName}/{fileName}")
 
     summary("Upload a file to an asset folder")
 

lib/cadet_web/admin_controllers/admin_courses_controller.ex

@@ -91,7 +91,7 @@ defmodule CadetWeb.AdminCoursesController do
   end
 
   swagger_path :update_course_config do
-    put("/v2/courses/{course_id}/admin/config")
+    put("/courses/{course_id}/admin/config")
 
     summary("Updates the course configuration for the specified course")
 
@@ -117,7 +117,7 @@ defmodule CadetWeb.AdminCoursesController do
   end
 
   swagger_path :update_assessment_configs do
-    put("/v2/courses/{course_id}/admin/config/assessment_configs")
+    put("/courses/{course_id}/admin/config/assessment_configs")
 
     summary("Updates the assessment configuration for the specified course")
 

lib/cadet_web/admin_controllers/admin_grading_controller.ex

@@ -118,7 +118,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :index do
-    get("/admin/grading")
+    get("/courses/{course_id}/admin/grading")
 
     summary("Get a list of all submissions with current user as the grader")
 
@@ -141,7 +141,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :unsubmit do
-    post("/admin/grading/{submissionId}/unsubmit")
+    post("/courses/{course_id}/admin/grading/{submissionId}/unsubmit")
     summary("Unsubmit submission. Can only be done by the Avenger of a student")
     security([%{JWT: []}])
 
@@ -156,7 +156,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :autograde_submission do
-    post("/admin/grading/{submissionId}/autograde")
+    post("/courses/{course_id}/admin/grading/{submissionId}/autograde")
     summary("Force re-autograding of an entire submission")
     security([%{JWT: []}])
 
@@ -171,7 +171,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :autograde_answer do
-    post("/admin/grading/{submissionId}/{questionId}/autograde")
+    post("/courses/{course_id}/admin/grading/{submissionId}/{questionId}/autograde")
     summary("Force re-autograding of a question in a submission")
     security([%{JWT: []}])
 
@@ -187,7 +187,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :show do
-    get("/admin/grading/{submissionId}")
+    get("/courses/{course_id}/admin/grading/{submissionId}")
 
     summary("Get information about a specific submission to be graded")
 
@@ -206,7 +206,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :update do
-    post("/admin/grading/{submissionId}/{questionId}")
+    post("/courses/{course_id}/admin/grading/{submissionId}/{questionId}")
 
     summary("Update marks given to the answer of a particular question in a submission")
 
@@ -228,7 +228,7 @@ defmodule CadetWeb.AdminGradingController do
   end
 
   swagger_path :grading_summary do
-    get("/admin/grading/summary")
+    get("/courses/{course_id}/admin/grading/summary")
 
     summary("Receives a summary of grading items done by this grader")
 

lib/cadet_web/admin_controllers/admin_stories_controller.ex

@@ -53,7 +53,7 @@ defmodule CadetWeb.AdminStoriesController do
   end
 
   swagger_path :create do
-    post("/v2{course_id}/stories")
+    post("/courses/{course_id}/admin/stories")
 
     summary("Creates a new story")
 
@@ -65,7 +65,7 @@ defmodule CadetWeb.AdminStoriesController do
   end
 
   swagger_path :delete do
-    PhoenixSwagger.Path.delete("/v2/courses/{course_id}/stories/{storyId}")
+    PhoenixSwagger.Path.delete("/courses/{course_id}/admin/stories/{storyId}")
 
     summary("Delete a story from database by id")
 
@@ -81,7 +81,7 @@ defmodule CadetWeb.AdminStoriesController do
   end
 
   swagger_path :update do
-    post("/v2/courses/{course_id}/stories/{storyId}")
+    post("/courses/{course_id}/admin/stories/{storyId}")
 
     summary("Update details regarding a story")
 

lib/cadet_web/admin_controllers/admin_user_controller.ex

@@ -179,7 +179,7 @@ defmodule CadetWeb.AdminUserController do
   end
 
   swagger_path :index do
-    get("/v2/courses/{course_id}/admin/users")
+    get("/courses/{course_id}/admin/users")
 
     summary("Returns a list of users in the course owned by the admin")
 
@@ -190,7 +190,7 @@ defmodule CadetWeb.AdminUserController do
   end
 
   swagger_path :combined_total_xp do
-    get("/v2/courses/{course_id}/admin/users/{course_reg_id}/total_xp")
+    get("/courses/{course_id}/admin/users/{course_reg_id}/total_xp")
 
     summary("Get the specified user's total XP from achievements and assessments")
 
@@ -206,8 +206,8 @@ defmodule CadetWeb.AdminUserController do
     response(401, "Unauthorised")
   end
 
-  swagger_path :add_users do
-    put("/v2/courses/{course_id}/admin/users")
+  swagger_path :upsert_users_and_groups do
+    put("/courses/{course_id}/admin/users")
 
     summary("Adds the list of usernames and roles to the course")
     security([%{JWT: []}])
@@ -228,7 +228,7 @@ defmodule CadetWeb.AdminUserController do
   end
 
   swagger_path :update_role do
-    put("/v2/courses/{course_id}/admin/users/role")
+    put("/courses/{course_id}/admin/users/{course_reg_id}/role")
 
     summary("Updates the role of the given user in the the course")
     security([%{JWT: []}])
@@ -257,7 +257,7 @@ defmodule CadetWeb.AdminUserController do
   end
 
   swagger_path :delete_user do
-    delete("/v2/courses/{course_id}/admin/users")
+    delete("/courses/{course_id}/admin/users/{course_reg_id}")
 
     summary("Deletes a user from a course")
     consumes("application/json")

lib/cadet_web/controllers/assessments_controller.ex

@@ -64,7 +64,7 @@ defmodule CadetWeb.AssessmentsController do
   end
 
   swagger_path :submit do
-    post("/assessments/{assessmentId}/submit")
+    post("/courses/{course_id}/assessments/{assessmentId}/submit")
     summary("Finalise submission for an assessment")
     security([%{JWT: []}])
 
@@ -84,7 +84,7 @@ defmodule CadetWeb.AssessmentsController do
   end
 
   swagger_path :index do
-    get("/assessments")
+    get("/courses/{course_id}/assessments")
 
     summary("Get a list of all assessments")
 
@@ -97,7 +97,7 @@ defmodule CadetWeb.AssessmentsController do
   end
 
   swagger_path :show do
-    get("/assessments/{assessmentId}")
+    get("/courses/{course_id}/assessments/{assessmentId}")
 
     summary("Get information about one particular assessment")
 
@@ -116,7 +116,7 @@ defmodule CadetWeb.AssessmentsController do
   end
 
   swagger_path :unlock do
-    post("/assessments/{assessmentId}/unlock")
+    post("/courses/{course_id}/assessments/{assessmentId}/unlock")
 
     summary("Unlocks a password-protected assessment and returns its information")
 

lib/cadet_web/controllers/courses_controller.ex

@@ -41,7 +41,7 @@ defmodule CadetWeb.CoursesController do
   end
 
   swagger_path :create do
-    post("/v2/config/create")
+    post("/config/create")
 
     summary("Creates a new course")
 
@@ -65,8 +65,8 @@ defmodule CadetWeb.CoursesController do
     end
   end
 
-  swagger_path :get_course_config do
-    get("/v2/courses/{course_id}/config")
+  swagger_path :index do
+    get("/courses/{course_id}/config")
 
     summary("Retrieves the course configuration of the specified course")
 

lib/cadet_web/controllers/incentives_controller.ex

@@ -39,7 +39,7 @@ defmodule CadetWeb.IncentivesController do
   end
 
   swagger_path :index_achievements do
-    get("/achievements")
+    get("/courses/{course_id}/achievements")
 
     summary("Gets achievements")
     security([%{JWT: []}])
@@ -49,7 +49,7 @@ defmodule CadetWeb.IncentivesController do
   end
 
   swagger_path :index_goals do
-    get("/self/goals")
+    get("/courses/{course_id}/self/goals")
 
     summary("Gets goals, including user's progress")
     security([%{JWT: []}])
@@ -59,7 +59,7 @@ defmodule CadetWeb.IncentivesController do
   end
 
   swagger_path :update_progress do
-    post("/self/goals/{uuid}/progress")
+    post("/courses/{course_id}/self/goals/{uuid}/progress")
 
     summary("Inserts or updates own goal progress of specifed goal")
     security([%{JWT: []}])

lib/cadet_web/controllers/notifications_controller.ex

@@ -39,7 +39,7 @@ defmodule CadetWeb.NotificationsController do
   end
 
   swagger_path :index do
-    get("/v2/courses/{course_id}/notifications")
+    get("/courses/{course_id}/notifications")
 
     summary("Get the unread notifications belonging to a user")
 
@@ -52,7 +52,7 @@ defmodule CadetWeb.NotificationsController do
   end
 
   swagger_path :acknowledge do
-    post("/v2/courses/{course_id}/notifications/acknowledge")
+    post("/courses/{course_id}/notifications/acknowledge")
     summary("Acknowledge notification(s)")
     security([%{JWT: []}])
 

lib/cadet_web/controllers/sourcecast_controller.ex

@@ -34,7 +34,7 @@ defmodule CadetWeb.SourcecastController do
   # end
 
   swagger_path :index do
-    get("/sourcecast")
+    get("/courses/{course_id}/sourcecast")
     description("Lists all sourcecasts")
     summary("Show all sourcecasts")
     produces("application/json")

lib/cadet_web/controllers/stories_controller.ex

@@ -11,7 +11,7 @@ defmodule CadetWeb.StoriesController do
   end
 
   swagger_path :index do
-    get("/v2/courses/{course_id}/stories")
+    get("/courses/{course_id}/stories")
 
     summary("Get a list of all stories")