1 files changed, 53 insertions, 13 deletions

diff --git a/lib/api/ci/triggers.rb b/lib/api/ci/triggers.rb
index c49f1c9e9e1..c202d188e43 100644
--- a/lib/api/ci/triggers.rb
+++ b/lib/api/ci/triggers.rb
@@ -11,16 +11,26 @@ module API
       urgency :low
 
       params do
-        requires :id, type: String, desc: 'The ID of a project'
+        requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project',
+                      documentation: { example: 18 }
       end
       resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
         desc 'Trigger a GitLab project pipeline' do
-          success Entities::Ci::Pipeline
+          success code: 201, model: Entities::Ci::Pipeline
+          failure [
+            { code: 400, message: 'Bad request' },
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' }
+          ]
         end
         params do
-          requires :ref, type: String, desc: 'The commit sha or name of a branch or tag', allow_blank: false
-          requires :token, type: String, desc: 'The unique token of trigger or job token'
-          optional :variables, type: Hash, desc: 'The list of variables to be injected into build'
+          requires :ref, type: String, desc: 'The commit sha or name of a branch or tag', allow_blank: false,
+                         documentation: { example: 'develop' }
+          requires :token, type: String, desc: 'The unique token of trigger or job token',
+                           documentation: { example: '6d056f63e50fe6f8c5f8f4aa10edb7' }
+          optional :variables, type: Hash, desc: 'The list of variables to be injected into build',
+                               documentation: { example: { VAR1: "value1", VAR2: "value2" } }
         end
         post ":id/(ref/:ref/)trigger/pipeline", requirements: { ref: /.+/ } do
           Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/20758')
@@ -47,7 +57,13 @@ module API
         end
 
         desc 'Get triggers list' do
-          success Entities::Trigger
+          success code: 200, model: Entities::Trigger
+          failure [
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' }
+          ]
+          is_array true
         end
         params do
           use :pagination
@@ -64,10 +80,15 @@ module API
         # rubocop: enable CodeReuse/ActiveRecord
 
         desc 'Get specific trigger of a project' do
-          success Entities::Trigger
+          success code: 200, model: Entities::Trigger
+          failure [
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' }
+          ]
         end
         params do
-          requires :trigger_id, type: Integer, desc: 'The trigger ID'
+          requires :trigger_id, type: Integer, desc: 'The trigger ID', documentation: { example: 10 }
         end
         get ':id/triggers/:trigger_id' do
           authenticate!
@@ -80,10 +101,17 @@ module API
         end
 
         desc 'Create a trigger' do
-          success Entities::Trigger
+          success code: 201, model: Entities::Trigger
+          failure [
+            { code: 400, message: 'Bad request' },
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' }
+          ]
         end
         params do
-          requires :description, type: String, desc: 'The trigger description'
+          requires :description, type: String, desc: 'The trigger description',
+                                 documentation: { example: 'my trigger description' }
         end
         post ':id/triggers' do
           authenticate!
@@ -100,7 +128,13 @@ module API
         end
 
         desc 'Update a trigger' do
-          success Entities::Trigger
+          success code: 200, model: Entities::Trigger
+          failure [
+            { code: 400, message: 'Bad request' },
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' }
+          ]
         end
         params do
           requires :trigger_id, type: Integer,  desc: 'The trigger ID'
@@ -123,10 +157,16 @@ module API
         end
 
         desc 'Delete a trigger' do
-          success Entities::Trigger
+          success code: 204
+          failure [
+            { code: 401, message: 'Unauthorized' },
+            { code: 403, message: 'Forbidden' },
+            { code: 404, message: 'Not found' },
+            { code: 412, message: 'Precondition Failed' }
+          ]
         end
         params do
-          requires :trigger_id, type: Integer, desc: 'The trigger ID'
+          requires :trigger_id, type: Integer, desc: 'The trigger ID', documentation: { example: 10 }
         end
         delete ':id/triggers/:trigger_id' do
           authenticate!