Class: OpenapiClient::ResourcesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/resources_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResourcesApi

Returns a new instance of ResourcesApi.



19
20
21
 
# File 'lib/openapi_client/api/resources_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/openapi_client/api/resources_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_resource(proj_id, env_id, resource_create, opts = {}) ⇒ ResourceRead

Create Resource Creates a new resource (a type of object you may protect with permissions).

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/openapi_client/api/resources_api.rb', line 29

def create_resource(proj_id, env_id, resource_create, opts = {})
  data, _status_code, _headers = create_resource_with_http_info(proj_id, env_id, resource_create, opts)
  data
end

#create_resource_with_http_info(proj_id, env_id, resource_create, opts = {}) ⇒ Array<(ResourceRead, Integer, Hash)>

Create Resource Creates a new resource (a type of object you may protect with permissions).

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    ResourceRead 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/openapi_client/api/resources_api.rb', line 41

def create_resource_with_http_info(proj_id, env_id, resource_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.create_resource ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.create_resource"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.create_resource"
  end
  # verify the required parameter 'resource_create' is set
  if @api_client.config.client_side_validation && resource_create.nil?
    fail ArgumentError, "Missing the required parameter 'resource_create' when calling ResourcesApi.create_resource"
  end
  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_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(resource_create)

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

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

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

#delete_resource(proj_id, env_id, resource_id, opts = {}) ⇒ nil

Delete Resource Deletes the resource and all its related data.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

  • (nil) 


109
110
111
112
 
# File 'lib/openapi_client/api/resources_api.rb', line 109

def delete_resource(proj_id, env_id, resource_id, opts = {})
  delete_resource_with_http_info(proj_id, env_id, resource_id, opts)
  nil
end

#delete_resource_with_http_info(proj_id, env_id, resource_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Resource Deletes the resource and all its related data.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
170
171
172
173
174
175
 
# File 'lib/openapi_client/api/resources_api.rb', line 121

def delete_resource_with_http_info(proj_id, env_id, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.delete_resource ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.delete_resource"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.delete_resource"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.delete_resource"
  end
  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_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'])

  # 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] || ['HTTPBearer']

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

#get_resource(proj_id, env_id, resource_id, opts = {}) ⇒ ResourceRead

Get Resource Gets a single resource, if such resource exists.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/openapi_client/api/resources_api.rb', line 184

def get_resource(proj_id, env_id, resource_id, opts = {})
  data, _status_code, _headers = get_resource_with_http_info(proj_id, env_id, resource_id, opts)
  data
end

#get_resource_with_http_info(proj_id, env_id, resource_id, opts = {}) ⇒ Array<(ResourceRead, Integer, Hash)>

Get Resource Gets a single resource, if such resource exists.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    ResourceRead data, response status code and response headers



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
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/openapi_client/api/resources_api.rb', line 196

def get_resource_with_http_info(proj_id, env_id, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.get_resource ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.get_resource"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.get_resource"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.get_resource"
  end
  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_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'])

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

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

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

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

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

#list_resources(proj_id, env_id, opts = {}) ⇒ Array<ResourceRead>

List Resources Lists all the resources defined in your schema.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :include_built_in (Boolean) —

    Whether to include or exclude built-in resources, default is False (default to false)

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



261
262
263
264
 
# File 'lib/openapi_client/api/resources_api.rb', line 261

def list_resources(proj_id, env_id, opts = {})
  data, _status_code, _headers = list_resources_with_http_info(proj_id, env_id, opts)
  data
end

#list_resources_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(Array<ResourceRead>, Integer, Hash)>

List Resources Lists all the resources defined in your schema.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :include_built_in (Boolean) —

    Whether to include or exclude built-in resources, default is False (default to false)

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

    Array<ResourceRead> data, response status code and response headers



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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/openapi_client/api/resources_api.rb', line 275

def list_resources_with_http_info(proj_id, env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.list_resources ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.list_resources"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.list_resources"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ResourcesApi.list_resources, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ResourcesApi.list_resources, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ResourcesApi.list_resources, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_built_in'] = opts[:'include_built_in'] if !opts[:'include_built_in'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<ResourceRead>'

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

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

#replace_resource(proj_id, env_id, resource_id, resource_replace, opts = {}) ⇒ ResourceRead

Replace Resource Completely replaces the resource definition. - If the resource key is changed, all role and permissions assignments for the the resource will be revoked. - If the resource key is unchanged, but some actions are removed or renamed from the resource definition, role and permissions assignments for these actions will be revoked. TODO: we need to decide if we are auto-revoking, or if we are rejecting the PUT completely while there are permissions that can be affected.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/openapi_client/api/resources_api.rb', line 350

def replace_resource(proj_id, env_id, resource_id, resource_replace, opts = {})
  data, _status_code, _headers = replace_resource_with_http_info(proj_id, env_id, resource_id, resource_replace, opts)
  data
end

#replace_resource_with_http_info(proj_id, env_id, resource_id, resource_replace, opts = {}) ⇒ Array<(ResourceRead, Integer, Hash)>

Replace Resource Completely replaces the resource definition. - If the resource key is changed, all role and permissions assignments for the the resource will be revoked. - If the resource key is unchanged, but some actions are removed or renamed from the resource definition, role and permissions assignments for these actions will be revoked. TODO: we need to decide if we are auto-revoking, or if we are rejecting the PUT completely while there are permissions that can be affected.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    ResourceRead data, response status code and response headers



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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/openapi_client/api/resources_api.rb', line 363

def replace_resource_with_http_info(proj_id, env_id, resource_id, resource_replace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.replace_resource ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.replace_resource"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.replace_resource"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.replace_resource"
  end
  # verify the required parameter 'resource_replace' is set
  if @api_client.config.client_side_validation && resource_replace.nil?
    fail ArgumentError, "Missing the required parameter 'resource_replace' when calling ResourcesApi.replace_resource"
  end
  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_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(resource_replace)

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

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

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

#update_resource(proj_id, env_id, resource_id, resource_update, opts = {}) ⇒ ResourceRead

Update Resource Partially updates the resource definition. Fields that will be provided will be completely overwritten.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:



436
437
438
439
 
# File 'lib/openapi_client/api/resources_api.rb', line 436

def update_resource(proj_id, env_id, resource_id, resource_update, opts = {})
  data, _status_code, _headers = update_resource_with_http_info(proj_id, env_id, resource_id, resource_update, opts)
  data
end

#update_resource_with_http_info(proj_id, env_id, resource_id, resource_update, opts = {}) ⇒ Array<(ResourceRead, Integer, Hash)>

Update Resource Partially updates the resource definition. Fields that will be provided will be completely overwritten.

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • resource_id (String) —

    Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the &quot;slug&quot;).

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

    the optional parameters

Returns:

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

    ResourceRead data, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/openapi_client/api/resources_api.rb', line 449

def update_resource_with_http_info(proj_id, env_id, resource_id, resource_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.update_resource ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourcesApi.update_resource"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourcesApi.update_resource"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.update_resource"
  end
  # verify the required parameter 'resource_update' is set
  if @api_client.config.client_side_validation && resource_update.nil?
    fail ArgumentError, "Missing the required parameter 'resource_update' when calling ResourcesApi.update_resource"
  end
  # resource path
  local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_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(resource_update)

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

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

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