Improve API with optinal and default. Allow to use scope as a parameter.

2 files changed, 25 insertions, 3 deletions

diff --git a/lib/api/pipeline_schedules.rb b/lib/api/pipeline_schedules.rb
index 5269239b7ed..52ad682b972 100644
--- a/lib/api/pipeline_schedules.rb
+++ b/lib/api/pipeline_schedules.rb
@@ -13,11 +13,15 @@ module API
       end
       params do
         use :pagination
+        optional :scope,    type: String, values: %w[active inactive],
+                            desc: 'The scope of pipeline schedules'
       end
       get ':id/pipeline_schedules' do
         authorize! :read_pipeline_schedule, user_project
 
-        present paginate(pipeline_schedules), with: Entities::PipelineSchedule
+        schedules = PipelineSchedulesFinder.new(user_project).execute(scope: params[:scope])
+          .preload([:owner, :last_pipeline])
+        present paginate(schedules), with: Entities::PipelineSchedule
       end
 
       desc 'Get a single pipeline schedule' do
@@ -41,8 +45,8 @@ module API
         requires :description, type: String, desc: 'The description of pipeline schedule'
         requires :ref, type: String, desc: 'The branch/tag name will be triggered'
         requires :cron, type: String, desc: 'The cron'
-        requires :cron_timezone, type: String, desc: 'The timezone'
-        requires :active, type: Boolean, desc: 'The activation of pipeline schedule'
+        optional :cron_timezone, type: String, default: 'UTC', desc: 'The timezone'
+        optional :active, type: Boolean, default: true, desc: 'The activation of pipeline schedule'
       end
       post ':id/pipeline_schedules' do
         authorize! :create_pipeline_schedule, user_project
diff --git a/spec/requests/api/pipeline_schedules_spec.rb b/spec/requests/api/pipeline_schedules_spec.rb
index 74de2f0ba4a..77bf377884d 100644
--- a/spec/requests/api/pipeline_schedules_spec.rb
+++ b/spec/requests/api/pipeline_schedules_spec.rb
@@ -43,6 +43,24 @@ describe API::PipelineSchedules do
           get api("/projects/#{project.id}/pipeline_schedules", developer)
         end.not_to exceed_query_limit(control_count)
       end
+
+      %w[active inactive].each do |target|
+        context "when scope is #{target}" do
+          before do
+            create(:ci_pipeline_schedule, project: project, active: active?(target))
+          end
+
+          it 'returns matched pipeline schedules' do
+            get api("/projects/#{project.id}/pipeline_schedules", developer), scope: target
+
+            expect(json_response.map{ |r| r['active'] }).to all(eq(active?(target)))
+          end
+        end
+
+        def active?(str)
+          (str == 'active') ? true : false
+        end
+      end
     end
 
     context 'authenticated user with invalid permissions' do