From 994e49b3fbc261f8e59429c1681d83c81ba25df3 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Tue, 28 Feb 2017 21:24:49 +0900 Subject: Fixed those points. - username to user_id - Drop duration - Resolve comments - Add Changelog - Edit docs --- lib/api/pipelines.rb | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) (limited to 'lib/api/pipelines.rb') diff --git a/lib/api/pipelines.rb b/lib/api/pipelines.rb index 905e72a3a95..48ab5c21780 100644 --- a/lib/api/pipelines.rb +++ b/lib/api/pipelines.rb @@ -14,18 +14,17 @@ module API end params do use :pagination - optional :scope, type: String, values: %w(running branches tags), - desc: 'Either running, branches, or tags' + optional :scope, type: String, values: %w(running pending finished branches tags), + desc: 'The scope of pipelines' optional :status, type: String, values: ['running', 'pending', 'success', 'failed', 'canceled', 'skipped'], - desc: 'Pipeline Status' - optional :ref, type: String, desc: 'Pipeline Ref' - optional :duration, type: Integer, desc: 'Greater than the specified duration' - optional :yaml_error, type: Boolean, desc: 'If true, returns only yaml error pipelines.' - optional :user_id, type: String, desc: 'User who executed pipelines' + desc: 'The status of pipelines' + optional :ref, type: String, desc: 'The ref of pipelines' + optional :yaml_errors, type: Boolean, desc: 'If true, Returns only yaml error pipelines' + optional :username, type: String, desc: 'The name of user who triggered pipelines' optional :order_by, type: String, values: ['id', 'status', 'ref', 'user_id', 'started_at', 'finished_at', 'created_at', 'updated_at'], default: 'id', - desc: 'Return issues ordered by `created_at` or `updated_at` fields.' + desc: 'The order_by which is combined with a sort' optional :sort, type: String, values: ['asc', 'desc'], default: 'desc', - desc: 'Return pipelines sorted in `asc` or `desc` order.' + desc: 'The sort method which is combined with an order_by' end get ':id/pipelines' do authorize! :read_pipeline, user_project -- cgit v1.2.1