Class: LaunchDarklyApi::ReleasePipelinesBetaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/release_pipelines_beta_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReleasePipelinesBetaApi

Returns a new instance of ReleasePipelinesBetaApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_release_pipeline(project_key, pipeline_key, opts = {}) ⇒ nil

Delete release pipeline Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the ‘defaultReleasePipelineKey`.

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 28

def delete_release_pipeline(project_key, pipeline_key, opts = {})
  delete_release_pipeline_with_http_info(project_key, pipeline_key, opts)
  nil
end

#delete_release_pipeline_with_http_info(project_key, pipeline_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete release pipeline Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the &#x60;defaultReleasePipelineKey&#x60;.

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 39

def delete_release_pipeline_with_http_info(project_key, pipeline_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.delete_release_pipeline ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.delete_release_pipeline"
  end
  # verify the required parameter 'pipeline_key' is set
  if @api_client.config.client_side_validation && pipeline_key.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_key' when calling ReleasePipelinesBetaApi.delete_release_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'pipelineKey' + '}', CGI.escape(pipeline_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.delete_release_pipeline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#delete_release_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_release_pipelines(project_key, opts = {}) ⇒ ReleasePipelineCollection

Get all release pipelines Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - ‘query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`.

Parameters:

  • project_key (String) —

    The project key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.

  • :limit (Integer) —

    The maximum number of items to return. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:



99
100
101
102
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 99

def get_all_release_pipelines(project_key, opts = {})
  data, _status_code, _headers = get_all_release_pipelines_with_http_info(project_key, opts)
  data
end

#get_all_release_pipelines_with_http_info(project_key, opts = {}) ⇒ Array<(ReleasePipelineCollection, Integer, Hash)>

Get all release pipelines Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - &#x60;query&#x60; is a string that matches against the release pipeline &#x60;key&#x60;, &#x60;name&#x60;, and &#x60;description&#x60;. It is not case sensitive. For example: &#x60;?filter&#x3D;query:examplePipeline&#x60;. - &#x60;env&#x60; is a string that matches an environment key. For example: &#x60;?filter&#x3D;env:production&#x60;.

Parameters:

  • project_key (String) —

    The project key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.

  • :limit (Integer) —

    The maximum number of items to return. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:

  • (Array<(ReleasePipelineCollection, Integer, Hash)>) —

    ReleasePipelineCollection data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 112

def get_all_release_pipelines_with_http_info(project_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.get_all_release_pipelines ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.get_all_release_pipelines"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReleasePipelineCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.get_all_release_pipelines",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#get_all_release_pipelines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_release_progressions_for_release_pipeline(project_key, pipeline_key, opts = {}) ⇒ ReleaseProgressionCollection

Get release progressions for release pipeline Get details on the progression of all releases, across all flags, for a release pipeline

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Accepts filter by &#x60;status&#x60; and &#x60;activePhaseId&#x60;. &#x60;status&#x60; can take a value of &#x60;completed&#x60; or &#x60;active&#x60;. &#x60;activePhaseId&#x60; takes a UUID and will filter results down to releases active on the specified phase. Providing &#x60;status equals completed&#x60; along with an &#x60;activePhaseId&#x60; filter will return an error as they are disjoint sets of data. The combination of &#x60;status equals active&#x60; and &#x60;activePhaseId&#x60; will return the same results as &#x60;activePhaseId&#x60; alone.

  • :limit (Integer) —

    The maximum number of items to return. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:



172
173
174
175
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 172

def get_all_release_progressions_for_release_pipeline(project_key, pipeline_key, opts = {})
  data, _status_code, _headers = get_all_release_progressions_for_release_pipeline_with_http_info(project_key, pipeline_key, opts)
  data
end

#get_all_release_progressions_for_release_pipeline_with_http_info(project_key, pipeline_key, opts = {}) ⇒ Array<(ReleaseProgressionCollection, Integer, Hash)>

Get release progressions for release pipeline Get details on the progression of all releases, across all flags, for a release pipeline

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Accepts filter by &#x60;status&#x60; and &#x60;activePhaseId&#x60;. &#x60;status&#x60; can take a value of &#x60;completed&#x60; or &#x60;active&#x60;. &#x60;activePhaseId&#x60; takes a UUID and will filter results down to releases active on the specified phase. Providing &#x60;status equals completed&#x60; along with an &#x60;activePhaseId&#x60; filter will return an error as they are disjoint sets of data. The combination of &#x60;status equals active&#x60; and &#x60;activePhaseId&#x60; will return the same results as &#x60;activePhaseId&#x60; alone.

  • :limit (Integer) —

    The maximum number of items to return. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 186

def get_all_release_progressions_for_release_pipeline_with_http_info(project_key, pipeline_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.get_all_release_progressions_for_release_pipeline ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.get_all_release_progressions_for_release_pipeline"
  end
  # verify the required parameter 'pipeline_key' is set
  if @api_client.config.client_side_validation && pipeline_key.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_key' when calling ReleasePipelinesBetaApi.get_all_release_progressions_for_release_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'pipelineKey' + '}', CGI.escape(pipeline_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReleaseProgressionCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.get_all_release_progressions_for_release_pipeline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#get_all_release_progressions_for_release_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_release_pipeline_by_key(project_key, pipeline_key, opts = {}) ⇒ ReleasePipeline

Get release pipeline by key Get a release pipeline by key

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 247

def get_release_pipeline_by_key(project_key, pipeline_key, opts = {})
  data, _status_code, _headers = get_release_pipeline_by_key_with_http_info(project_key, pipeline_key, opts)
  data
end

#get_release_pipeline_by_key_with_http_info(project_key, pipeline_key, opts = {}) ⇒ Array<(ReleasePipeline, Integer, Hash)>

Get release pipeline by key Get a release pipeline by key

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReleasePipeline, Integer, Hash)>) —

    ReleasePipeline data, response status code and response headers



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 258

def get_release_pipeline_by_key_with_http_info(project_key, pipeline_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.get_release_pipeline_by_key ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.get_release_pipeline_by_key"
  end
  # verify the required parameter 'pipeline_key' is set
  if @api_client.config.client_side_validation && pipeline_key.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_key' when calling ReleasePipelinesBetaApi.get_release_pipeline_by_key"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'pipelineKey' + '}', CGI.escape(pipeline_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReleasePipeline'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.get_release_pipeline_by_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#get_release_pipeline_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_release_pipeline(project_key, create_release_pipeline_input, opts = {}) ⇒ ReleasePipeline

Create a release pipeline Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the ‘defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.

Parameters:

  • project_key (String) —

    The project key

  • create_release_pipeline_input (CreateReleasePipelineInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



316
317
318
319
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 316

def post_release_pipeline(project_key, create_release_pipeline_input, opts = {})
  data, _status_code, _headers = post_release_pipeline_with_http_info(project_key, create_release_pipeline_input, opts)
  data
end

#post_release_pipeline_with_http_info(project_key, create_release_pipeline_input, opts = {}) ⇒ Array<(ReleasePipeline, Integer, Hash)>

Create a release pipeline Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the &#x60;defaultReleasePipelineKey&#x60;. You can create up to 20 release pipelines per project.

Parameters:

  • project_key (String) —

    The project key

  • create_release_pipeline_input (CreateReleasePipelineInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReleasePipeline, Integer, Hash)>) —

    ReleasePipeline data, response status code and response headers



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 327

def post_release_pipeline_with_http_info(project_key, create_release_pipeline_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.post_release_pipeline ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.post_release_pipeline"
  end
  # verify the required parameter 'create_release_pipeline_input' is set
  if @api_client.config.client_side_validation && create_release_pipeline_input.nil?
    fail ArgumentError, "Missing the required parameter 'create_release_pipeline_input' when calling ReleasePipelinesBetaApi.post_release_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_release_pipeline_input)

  # return_type
  return_type = opts[:debug_return_type] || 'ReleasePipeline'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.post_release_pipeline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#post_release_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_release_pipeline(project_key, pipeline_key, update_release_pipeline_input, opts = {}) ⇒ ReleasePipeline

Update a release pipeline Updates a release pipeline.

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • update_release_pipeline_input (UpdateReleasePipelineInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 391

def put_release_pipeline(project_key, pipeline_key, update_release_pipeline_input, opts = {})
  data, _status_code, _headers = put_release_pipeline_with_http_info(project_key, pipeline_key, update_release_pipeline_input, opts)
  data
end

#put_release_pipeline_with_http_info(project_key, pipeline_key, update_release_pipeline_input, opts = {}) ⇒ Array<(ReleasePipeline, Integer, Hash)>

Update a release pipeline Updates a release pipeline.

Parameters:

  • project_key (String) —

    The project key

  • pipeline_key (String) —

    The release pipeline key

  • update_release_pipeline_input (UpdateReleasePipelineInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReleasePipeline, Integer, Hash)>) —

    ReleasePipeline data, response status code and response headers



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/launchdarkly_api/api/release_pipelines_beta_api.rb', line 403

def put_release_pipeline_with_http_info(project_key, pipeline_key, update_release_pipeline_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasePipelinesBetaApi.put_release_pipeline ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePipelinesBetaApi.put_release_pipeline"
  end
  # verify the required parameter 'pipeline_key' is set
  if @api_client.config.client_side_validation && pipeline_key.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_key' when calling ReleasePipelinesBetaApi.put_release_pipeline"
  end
  # verify the required parameter 'update_release_pipeline_input' is set
  if @api_client.config.client_side_validation && update_release_pipeline_input.nil?
    fail ArgumentError, "Missing the required parameter 'update_release_pipeline_input' when calling ReleasePipelinesBetaApi.put_release_pipeline"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'pipelineKey' + '}', CGI.escape(pipeline_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_release_pipeline_input)

  # return_type
  return_type = opts[:debug_return_type] || 'ReleasePipeline'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ReleasePipelinesBetaApi.put_release_pipeline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasePipelinesBetaApi#put_release_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end