File: pipelines_helpers.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (42 lines) | stat: -rw-r--r-- 1,609 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# frozen_string_literal: true

module API
  module Ci
    module Helpers
      module PipelinesHelpers
        extend ActiveSupport::Concern
        extend Grape::API::Helpers

        params :optional_scope do
          optional :scope, types: [String, Array[String]], desc: 'The scope of builds to show',
            values: ::CommitStatus::AVAILABLE_STATUSES,
            coerce_with: ->(scope) {
                           case scope
                           when String
                             [scope]
                           when ::Array
                             scope
                           else
                             ['unknown']
                           end
                         },
            documentation: { example: %w[pending running] }
        end

        params :create_pipeline_params do
          requires :ref, type: String, desc: 'Reference',
            documentation: { example: 'develop' }
          optional :variables, type: Array, desc: 'Array of variables available in the pipeline' do
            optional :key, type: String, desc: 'The key of the variable', documentation: { example: 'UPLOAD_TO_S3' }
            optional :value, type: String, desc: 'The value of the variable', documentation: { example: 'true' }
            optional :variable_type, type: String,
              values: ::Ci::PipelineVariable.variable_types.keys, default: 'env_var',
              desc: 'The type of variable, must be one of env_var or file. Defaults to env_var'
          end
        end
      end
    end
  end
end

API::Ci::Helpers::PipelinesHelpers.prepend_mod