Class: DatadogAPIClient::V2::APIManagementAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/api_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ APIManagementAPI

Returns a new instance of APIManagementAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_open_api(opts = {}) ⇒ Object

Create a new API.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 29

def create_open_api(opts = {})
  data, _status_code, _headers = create_open_api_with_http_info(opts)
  data
end

#create_open_api_with_http_info(opts = {}) ⇒ Array<(CreateOpenAPIResponse, Integer, Hash)>

Create a new API.

Create a new API from the [OpenAPI](spec.openapis.org/oas/latest.html) specification given. See the [API Catalog documentation](docs.datadoghq.com/api_catalog/add_metadata/) for additional information about the possible metadata. It returns the created API ID.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :openapi_spec_file (File) —

    Binary ‘OpenAPI` spec file

Returns:

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

    CreateOpenAPIResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 45

def create_open_api_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_open_api".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_open_api")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_open_api"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIManagementAPI.create_open_api ...'
  end
  # resource path
  local_var_path = '/api/v2/apicatalog/openapi'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['openapi_spec_file'] = opts[:'openapi_spec_file'] if !opts[:'openapi_spec_file'].nil?

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_open_api,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_open_api(id, opts = {}) ⇒ Object

Delete an API.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 103

def delete_open_api(id, opts = {})
  delete_open_api_with_http_info(id, opts)
  nil
end

#delete_open_api_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an API.

Delete a specific API by ID.

Parameters:

  • id (UUID) —

    ID of the API to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
162
163
164
165
166
167
168
169
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 115

def delete_open_api_with_http_info(id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_open_api".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_open_api")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_open_api"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIManagementAPI.delete_open_api ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling APIManagementAPI.delete_open_api"
  end
  # resource path
  local_var_path = '/api/v2/apicatalog/api/{id}'.sub('{id}', CGI.escape(id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

  # 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] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_open_api,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_open_api(id, opts = {}) ⇒ Object

Get an API.

See Also:



174
175
176
177
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 174

def get_open_api(id, opts = {})
  data, _status_code, _headers = get_open_api_with_http_info(id, opts)
  data
end

#get_open_api_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get an API.

Retrieve information about a specific API in [OpenAPI](spec.openapis.org/oas/latest.html) format file.

Parameters:

  • id (UUID) —

    ID of the API to retrieve

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
240
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 186

def get_open_api_with_http_info(id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_open_api".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_open_api")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_open_api"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIManagementAPI.get_open_api ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling APIManagementAPI.get_open_api"
  end
  # resource path
  local_var_path = '/api/v2/apicatalog/api/{id}/openapi'.sub('{id}', CGI.escape(id.to_s).gsub('%2F', '/'))

  # 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(['multipart/form-data', '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] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_open_api,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_apis(opts = {}) ⇒ Object

List APIs.

See Also:



245
246
247
248
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 245

def list_apis(opts = {})
  data, _status_code, _headers = list_apis_with_http_info(opts)
  data
end

#list_apis_with_http_info(opts = {}) ⇒ Array<(ListAPIsResponse, Integer, Hash)>

List APIs.

List APIs and their IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    Filter APIs by name

  • :page_limit (Integer) —

    Number of items per page.

  • :page_offset (Integer) —

    Offset for pagination.

Returns:

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

    ListAPIsResponse 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/datadog_api_client/v2/api/api_management_api.rb', line 259

def list_apis_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_apis".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_apis")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_apis"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIManagementAPI.list_apis ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling APIManagementAPI.list_apis, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_offset'].nil? && opts[:'page_offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_offset"]" when calling APIManagementAPI.list_apis, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/apicatalog/api'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_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] || 'ListAPIsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_apis,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_open_api(id, opts = {}) ⇒ Object

Update an API.

See Also:



323
324
325
326
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 323

def update_open_api(id, opts = {})
  data, _status_code, _headers = update_open_api_with_http_info(id, opts)
  data
end

#update_open_api_with_http_info(id, opts = {}) ⇒ Array<(UpdateOpenAPIResponse, Integer, Hash)>

Update an API.

Update information about a specific API. The given content will replace all API content of the given ID. The ID is returned by the create API, or can be found in the URL in the API catalog UI.

Parameters:

  • id (UUID) —

    ID of the API to modify

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

    the optional parameters

Options Hash (opts):

  • :openapi_spec_file (File) —

    Binary ‘OpenAPI` spec file

Returns:

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

    UpdateOpenAPIResponse data, response status code and response headers



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
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/datadog_api_client/v2/api/api_management_api.rb', line 338

def update_open_api_with_http_info(id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_open_api".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_open_api")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_open_api"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIManagementAPI.update_open_api ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling APIManagementAPI.update_open_api"
  end
  # resource path
  local_var_path = '/api/v2/apicatalog/api/{id}/openapi'.sub('{id}', CGI.escape(id.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['openapi_spec_file'] = opts[:'openapi_spec_file'] if !opts[:'openapi_spec_file'].nil?

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_open_api,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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