fix: correct routes for swagger support

Author: macite

app/api/feedback/feedback_chip_api.rb

@@ -11,11 +11,11 @@ class FeedbackChipApi < Grape::API
       authenticated?
     end
 
-    route :context_type_plural, values: %w[units task_definitions] do
-      params[:context_type].pluralize
-    end
-
     desc "Get all feedback chips for a context"
+    params do
+      requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
+      requires :context_id, type: Integer, desc: 'The ID of the context'
+    end
     get '/:context_type_plural/:context_id/feedback_chips' do
       context_type = params[:context_type_plural].singularize.camelize
       context_model = context_type.classify.constantize.find(params[:context_id])
@@ -153,6 +153,7 @@ class FeedbackChipApi < Grape::API
     desc 'Download the feedback chips for a specific outcome' # change to specific context rather than outcome
     params do
       requires :id, type: Integer, desc: 'The ID of the context'
+      requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
     end
     get '/:context_type_plural/:context_id/outcomes/:id/feedback_chips/csv' do
       # find context model dynamically
@@ -177,6 +178,7 @@ class FeedbackChipApi < Grape::API
     params do
       requires :context_id, type: Integer, desc: 'The ID of the context'
       optional :includes_tlos, type: Boolean, desc: 'Include TLOs in the export'
+      requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
     end
     get '/:context_type_plural/:context_id/feedback_chips/csv' do
       include_tlos = params[:includes_tlos] || false
@@ -201,13 +203,18 @@ class FeedbackChipApi < Grape::API
     params do
       requires :file, type: File, desc: 'CSV upload file.'
       requires :id, type: Integer, desc: 'The id of the learning outcome'
+      requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
+      requires :context_id, type: Integer, desc: 'The ID of the context'
     end
     post '/:context_type_plural/:context_id/outcomes/:id/feedback_chips/csv' do
       # check mime is correct before uploading
       ensure_csv!(params[:file][:tempfile])
 
+      context_type = params[:context_type_plural].singularize.camelize
+      context_model = context_type.classify.constantize.find(params[:context_id])
+
       # find context model dynamically
-      learning_outcome = LearningOutcome.find(params[:id])
+      learning_outcome = context_model.learning_outcomes.find(params[:id])
 
       unless authorise? current_user, learning_outcome, :upload_csv
         error!({ error: 'Not authorised to upload CSV of outcomes' }, 403)
@@ -220,6 +227,7 @@ class FeedbackChipApi < Grape::API
     desc 'Upload the feedback chips for a specified context from a csv'
     params do
       requires :file, type: File, desc: 'CSV upload file.'
+      requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
       requires :context_id, type: Integer, desc: 'The ID of the context'
     end
     post '/:context_type_plural/:context_id/feedback_chips/csv' do

app/api/learning_outcomes_api.rb

@@ -10,10 +10,6 @@ class LearningOutcomesApi < Grape::API
     authenticated?
   end
 
-  route :context_type_plural, values: %w[units task_definitions] do
-    params[:context_type].pluralize
-  end
-
   desc 'Get all global outcomes'
   get '/global/outcomes' do
     # can be read by any logged in user
@@ -26,6 +22,7 @@ class LearningOutcomesApi < Grape::API
     requires :short_description, type: String, desc: 'The ILO''s short_description'
     optional :full_outcome_description, type: String, desc: 'The ILO''s full_outcome_description'
     optional :linked_outcome_ids, type: Array[Integer], desc: 'The ids of the linked outcome ids'
+    requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
   end
   post '/:context_type_plural/:context_id/outcomes' do
     # find context model dynamically
@@ -36,7 +33,7 @@ class LearningOutcomesApi < Grape::API
       error!({ error: 'You are not authorised to create outcomes in this context.' }, 403)
     end
 
-    outcome_params = declared(params, include_missing: false).except(:linked_outcome_ids)
+    outcome_params = declared(params, include_missing: false).except(:linked_outcome_ids, :context_type_plural)
     outcome_params[:context_type] = context_type
 
     learning_outcome = context_model.learning_outcomes.create!(outcome_params)
@@ -76,6 +73,7 @@ class LearningOutcomesApi < Grape::API
     optional :full_outcome_description, type: String, desc: 'The ILO''s full_outcome_description'
     optional :linked_outcome_ids, type: Array[Integer], desc: 'The ids of the linked outcome ids'
     # optional :ilo_number, type: Integer, desc: 'The ILO''s new sequence number'
+    requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
   end
   put '/:context_type_plural/:context_id/outcomes/:id' do
     # find context model dynamically
@@ -128,6 +126,7 @@ class LearningOutcomesApi < Grape::API
   params do
     requires :context_id, type: Integer, desc: 'The id of the context'
     requires :id, type: Integer, desc: 'The id for the outcome you wish to delete'
+    requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
   end
   delete '/:context_type_plural/:context_id/outcomes/:id' do
     # find context model dynamically
@@ -165,6 +164,7 @@ class LearningOutcomesApi < Grape::API
   params do
     requires :context_id, type: Integer, desc: 'The id of the context'
     optional :includes_tlos, type: Boolean, desc: 'Include nested task learning outcomes in the export'
+    requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
   end
   get '/:context_type_plural/:context_id/outcomes/csv' do
     # find context model dynamically
@@ -190,6 +190,7 @@ class LearningOutcomesApi < Grape::API
   params do
     requires :file, type: File, desc: 'CSV upload file.'
     requires :context_id, type: Integer, desc: 'The id of the context'
+    requires :context_type_plural, type: String, desc: 'The context - a unit or task_definition', values: %w[units task_definitions]
   end
   post '/:context_type_plural/:context_id/outcomes/csv' do
     # check mime is correct before uploading

app/api/tii/tii_action_api.rb

@@ -12,7 +12,7 @@ class TiiActionApi < Grape::API
 
     desc 'Get the outstanding turn it in actions'
     params do
-      optional :unit_id, type: Integer, desc: 'The id of the unit to filter by', default: nil
+      optional :unit_id, type: Integer, desc: 'The id of the unit to filter by'
       optional :limit, type: Integer, desc: 'The maximum number of actions to return', default: 50
       optional :offset, type: Integer, desc: 'The offset to start from', default: 0
       optional :show_complete, type: Boolean, desc: 'Include complete actions?', default: false
@@ -38,10 +38,10 @@ class TiiActionApi < Grape::API
     desc 'Trigger an action on the given group attachment'
     params do
       requires :action, type: String, desc: 'The action to perform: retry'
-      optional :unit_id, type: Integer, desc: 'The id of the unit to filter by', default: nil
+      # optional :unit_id, type: Integer, desc: 'The id of the unit to filter by'
     end
     put '/tii_actions/:id' do
-      unit = Unit.find(params[:unit_id]) if params[:unit_id].present?
+      # unit = Unit.find(params[:unit_id]) if params[:unit_id].present?
 
       unless authorise?(current_user, User, :admin_units)
         error!({ error: 'Not authorised to retry tasks' }, 403)