Class: LaunchDarklyApi::ReleasesBetaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReleasesBetaApi

Returns a new instance of ReleasesBetaApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/releases_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/releases_beta_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_release_for_flag(project_key, flag_key, create_release_input, opts = {}) ⇒ Release

Create a new release for flag Creates a release by adding a flag to a release pipeline

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 29

def create_release_for_flag(project_key, flag_key, create_release_input, opts = {})
  data, _status_code, _headers = create_release_for_flag_with_http_info(project_key, flag_key, create_release_input, opts)
  data
end

#create_release_for_flag_with_http_info(project_key, flag_key, create_release_input, opts = {}) ⇒ Array<(Release, Integer, Hash)>

Create a new release for flag Creates a release by adding a flag to a release pipeline

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:

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

    Release data, response status code and response headers



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
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 41

def create_release_for_flag_with_http_info(project_key, flag_key, create_release_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasesBetaApi.create_release_for_flag ...'
  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 ReleasesBetaApi.create_release_for_flag"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling ReleasesBetaApi.create_release_for_flag"
  end
  # verify the required parameter 'create_release_input' is set
  if @api_client.config.client_side_validation && create_release_input.nil?
    fail ArgumentError, "Missing the required parameter 'create_release_input' when calling ReleasesBetaApi.create_release_for_flag"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/flags/{flagKey}/release'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_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_input)

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

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

  new_options = opts.merge(
    :operation => :"ReleasesBetaApi.create_release_for_flag",
    :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: ReleasesBetaApi#create_release_for_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_release_by_flag_key(project_key, flag_key, opts = {}) ⇒ nil

Delete a release for flag Deletes a release from a flag

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:

  • (nil) 


108
109
110
111
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 108

def delete_release_by_flag_key(project_key, flag_key, opts = {})
  delete_release_by_flag_key_with_http_info(project_key, flag_key, opts)
  nil
end

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

Delete a release for flag Deletes a release from a flag

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
162
163
164
165
166
167
168
169
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 119

def delete_release_by_flag_key_with_http_info(project_key, flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasesBetaApi.delete_release_by_flag_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 ReleasesBetaApi.delete_release_by_flag_key"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling ReleasesBetaApi.delete_release_by_flag_key"
  end
  # resource path
  local_var_path = '/api/v2/flags/{projectKey}/{flagKey}/release'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_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 => :"ReleasesBetaApi.delete_release_by_flag_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasesBetaApi#delete_release_by_flag_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_release_by_flag_key(project_key, flag_key, opts = {}) ⇒ Release

Get release for flag Get currently active release for a flag

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:



177
178
179
180
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 177

def get_release_by_flag_key(project_key, flag_key, opts = {})
  data, _status_code, _headers = get_release_by_flag_key_with_http_info(project_key, flag_key, opts)
  data
end

#get_release_by_flag_key_with_http_info(project_key, flag_key, opts = {}) ⇒ Array<(Release, Integer, Hash)>

Get release for flag Get currently active release for a flag

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

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

    the optional parameters

Returns:

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

    Release data, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 188

def get_release_by_flag_key_with_http_info(project_key, flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasesBetaApi.get_release_by_flag_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 ReleasesBetaApi.get_release_by_flag_key"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling ReleasesBetaApi.get_release_by_flag_key"
  end
  # resource path
  local_var_path = '/api/v2/flags/{projectKey}/{flagKey}/release'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_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] || 'Release'

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

  new_options = opts.merge(
    :operation => :"ReleasesBetaApi.get_release_by_flag_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: ReleasesBetaApi#get_release_by_flag_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_release_by_flag_key(project_key, flag_key, patch_operation, opts = {}) ⇒ Release

Patch release for flag This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. Update currently active release for a flag. Updating releases requires the [JSON patch](datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the ‘path`. For example, to mark the first phase of a release as complete, use the following request body: “` [ { "op": "replace", "path": "/phase/0/complete", "value": true } ] “`

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

def patch_release_by_flag_key(project_key, flag_key, patch_operation, opts = {})
  data, _status_code, _headers = patch_release_by_flag_key_with_http_info(project_key, flag_key, patch_operation, opts)
  data
end

#patch_release_by_flag_key_with_http_info(project_key, flag_key, patch_operation, opts = {}) ⇒ Array<(Release, Integer, Hash)>

Patch release for flag This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. Update currently active release for a flag. Updating releases requires the [JSON patch](datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the &#x60;path&#x60;. For example, to mark the first phase of a release as complete, use the following request body: &#x60;&#x60;&#x60; [ { &quot;op&quot;: &quot;replace&quot;, &quot;path&quot;: &quot;/phase/0/complete&quot;, &quot;value&quot;: true } ] &#x60;&#x60;&#x60;

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Release data, response status code and response headers



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
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 259

def patch_release_by_flag_key_with_http_info(project_key, flag_key, patch_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasesBetaApi.patch_release_by_flag_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 ReleasesBetaApi.patch_release_by_flag_key"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling ReleasesBetaApi.patch_release_by_flag_key"
  end
  # verify the required parameter 'patch_operation' is set
  if @api_client.config.client_side_validation && patch_operation.nil?
    fail ArgumentError, "Missing the required parameter 'patch_operation' when calling ReleasesBetaApi.patch_release_by_flag_key"
  end
  # resource path
  local_var_path = '/api/v2/flags/{projectKey}/{flagKey}/release'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_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(patch_operation)

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

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

  new_options = opts.merge(
    :operation => :"ReleasesBetaApi.patch_release_by_flag_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReleasesBetaApi#patch_release_by_flag_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_phase_status(project_key, flag_key, phase_id, update_phase_status_input, opts = {}) ⇒ Release

Update phase status for release Updates the execution status of a phase of a release

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

  • phase_id (String) —

    The phase ID

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

    the optional parameters

Returns:



328
329
330
331
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 328

def update_phase_status(project_key, flag_key, phase_id, update_phase_status_input, opts = {})
  data, _status_code, _headers = update_phase_status_with_http_info(project_key, flag_key, phase_id, update_phase_status_input, opts)
  data
end

#update_phase_status_with_http_info(project_key, flag_key, phase_id, update_phase_status_input, opts = {}) ⇒ Array<(Release, Integer, Hash)>

Update phase status for release Updates the execution status of a phase of a release

Parameters:

  • project_key (String) —

    The project key

  • flag_key (String) —

    The flag key

  • phase_id (String) —

    The phase ID

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

    the optional parameters

Returns:

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

    Release data, response status code and response headers



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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/launchdarkly_api/api/releases_beta_api.rb', line 341

def update_phase_status_with_http_info(project_key, flag_key, phase_id, update_phase_status_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleasesBetaApi.update_phase_status ...'
  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 ReleasesBetaApi.update_phase_status"
  end
  # verify the required parameter 'flag_key' is set
  if @api_client.config.client_side_validation && flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'flag_key' when calling ReleasesBetaApi.update_phase_status"
  end
  # verify the required parameter 'phase_id' is set
  if @api_client.config.client_side_validation && phase_id.nil?
    fail ArgumentError, "Missing the required parameter 'phase_id' when calling ReleasesBetaApi.update_phase_status"
  end
  # verify the required parameter 'update_phase_status_input' is set
  if @api_client.config.client_side_validation && update_phase_status_input.nil?
    fail ArgumentError, "Missing the required parameter 'update_phase_status_input' when calling ReleasesBetaApi.update_phase_status"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s)).sub('{' + 'phaseId' + '}', CGI.escape(phase_id.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_phase_status_input)

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

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

  new_options = opts.merge(
    :operation => :"ReleasesBetaApi.update_phase_status",
    :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: ReleasesBetaApi#update_phase_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end