Class: LinodeOpenapiClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/linode_openapi_client/configuration.rb', line 159

def initialize
  @scheme = 'https'
  @host = 'api.linode.com'
  @base_path = ''
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @cert_file = nil
  @key_file = nil
  @timeout = 0
  @params_encoding = nil
  @debugging = false
  @ignore_operation_servers = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



63
64
65
 
# File 'lib/linode_openapi_client/configuration.rb', line 63

def access_token
  @access_token
end

#access_token_getter ⇒ Proc

Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2. Overrides the access_token if set

Returns:

  • (Proc) 


68
69
70
 
# File 'lib/linode_openapi_client/configuration.rb', line 68

def access_token_getter
  @access_token_getter
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



42
43
44
 
# File 'lib/linode_openapi_client/configuration.rb', line 42

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



50
51
52
 
# File 'lib/linode_openapi_client/configuration.rb', line 50

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



22
23
24
 
# File 'lib/linode_openapi_client/configuration.rb', line 22

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



141
142
143
 
# File 'lib/linode_openapi_client/configuration.rb', line 141

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


110
111
112
 
# File 'lib/linode_openapi_client/configuration.rb', line 110

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


80
81
82
 
# File 'lib/linode_openapi_client/configuration.rb', line 80

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



157
158
159
 
# File 'lib/linode_openapi_client/configuration.rb', line 157

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



19
20
21
 
# File 'lib/linode_openapi_client/configuration.rb', line 19

def host
  @host
end

#ignore_operation_servers ⇒ true, false

Set this to ignore operation servers for the API client. This is useful when you need to send requests to a different server than the one specified in the OpenAPI document. Will default to the base url defined in the spec but can be overridden by setting ‘scheme`, `host`, `base_path` directly. Default to false.

Returns:

  • (true, false) 


88
89
90
 
# File 'lib/linode_openapi_client/configuration.rb', line 88

def ignore_operation_servers
  @ignore_operation_servers
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



155
156
157
 
# File 'lib/linode_openapi_client/configuration.rb', line 155

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



145
146
147
 
# File 'lib/linode_openapi_client/configuration.rb', line 145

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


94
95
96
 
# File 'lib/linode_openapi_client/configuration.rb', line 94

def logger
  @logger
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


152
153
154
 
# File 'lib/linode_openapi_client/configuration.rb', line 152

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


60
61
62
 
# File 'lib/linode_openapi_client/configuration.rb', line 60

def password
  @password
end

#return_binary_data ⇒ Object

Set this to return data as binary instead of downloading a temp file. When enabled (set to true) HTTP responses with return type ‘File` will be returned as a stream of binary data. Default to false.



73
74
75
 
# File 'lib/linode_openapi_client/configuration.rb', line 73

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



16
17
18
 
# File 'lib/linode_openapi_client/configuration.rb', line 16

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



25
26
27
 
# File 'lib/linode_openapi_client/configuration.rb', line 25

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



28
29
30
 
# File 'lib/linode_openapi_client/configuration.rb', line 28

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



34
35
36
 
# File 'lib/linode_openapi_client/configuration.rb', line 34

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



31
32
33
 
# File 'lib/linode_openapi_client/configuration.rb', line 31

def server_variables
  @server_variables
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


137
138
139
 
# File 'lib/linode_openapi_client/configuration.rb', line 137

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


101
102
103
 
# File 'lib/linode_openapi_client/configuration.rb', line 101

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



105
106
107
 
# File 'lib/linode_openapi_client/configuration.rb', line 105

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


55
56
57
 
# File 'lib/linode_openapi_client/configuration.rb', line 55

def username
  @username
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


119
120
121
 
# File 'lib/linode_openapi_client/configuration.rb', line 119

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


128
129
130
 
# File 'lib/linode_openapi_client/configuration.rb', line 128

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



186
187
188
 
# File 'lib/linode_openapi_client/configuration.rb', line 186

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#access_token_with_refresh ⇒ Object

Gets access_token using access_token_getter or uses the static access_token



234
235
236
237
 
# File 'lib/linode_openapi_client/configuration.rb', line 234

def access_token_with_refresh
  return access_token if access_token_getter.nil?
  access_token_getter.call
end

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



223
224
225
226
227
228
229
230
231
 
# File 'lib/linode_openapi_client/configuration.rb', line 223

def api_key_with_prefix(param_name, param_alias = nil)
  key = @api_key[param_name]
  key = @api_key.fetch(param_alias, key) unless param_alias.nil?
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{key}"
  else
    key
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/linode_openapi_client/configuration.rb', line 245

def auth_settings
  {
    'oauth' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token_with_refresh}"
      },
    'personalAccessToken' =>
      {
        type: 'bearer',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token_with_refresh}"
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



211
212
213
214
215
216
217
218
219
 
# File 'lib/linode_openapi_client/configuration.rb', line 211

def base_url(operation = nil)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
  if operation_server_settings.key?(operation) then
    index = server_operation_index.fetch(operation, server_index)
    server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
  else
    server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
  end
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



240
241
242
 
# File 'lib/linode_openapi_client/configuration.rb', line 240

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



190
191
192
 
# File 'lib/linode_openapi_client/configuration.rb', line 190

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



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
319
320
321
322
323
324
325
326
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
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
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
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/linode_openapi_client/configuration.rb', line 274

def operation_server_settings
  {
    "AccountApi.get_account_availability": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.get_availability": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.get_enrolled_beta_program": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.get_enrolled_beta_programs": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.get_maintenance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "AccountApi.get_payment_method": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.get_payment_methods": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "AccountApi.post_beta_program": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.post_make_payment_method_default": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "AccountApi.post_payment_method": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "BetaProgramsApi.get_beta_program": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "BetaProgramsApi.get_beta_programs": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "DatabasesApi.delete_database_mysql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.delete_database_postgre_sql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.delete_databases_mysql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.delete_databases_postgre_sql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_engine": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_engines": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_instances": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instance_backups": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instance_credentials": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instance_ssl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_mysql_instances": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgre_sql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgre_sql_instance_backups": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgre_sql_instance_credentials": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgre_sql_instances": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgresql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_postgresql_instance_ssl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_type": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.get_databases_types": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_mysql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_mysql_instance_backup_restore": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_mysql_instance_credentials_reset": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_mysql_instance_patch": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_mysql_instances": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_postgre_sql_instance_backup": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_postgre_sql_instance_backup_restore": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_postgre_sql_instance_credentials_reset": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_postgre_sql_instance_patch": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.post_databases_postgre_sql_instances": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.put_databases_mysql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "DatabasesApi.put_databases_postgre_sql_instance": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "ImagesApi.post_upload_image": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      },
      {
      url: "https://api.linode.com/v4beta",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.delete_linode_config_interface": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.get_linode_config_interface": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.get_linode_config_interfaces": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.post_linode_config_interface": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.post_linode_config_interfaces": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "LinodeInstancesApi.put_linode_config_interface": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.delete_firewall": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.delete_firewall_device": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_firewall": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_firewall_device": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_firewall_devices": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_firewall_rules": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_firewalls": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.get_vlans": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.post_firewall_device": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.post_firewalls": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.post_share_ips": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.put_firewall": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "NetworkingApi.put_firewall_rules": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.delete_object_storage_bucket": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.delete_object_storage_key": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.delete_object_storage_ssl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_bucket": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_bucket_acl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_bucket_content": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_bucketin_cluster": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_buckets": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_cluster": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_clusters": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_key": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_keys": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_ssl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.get_object_storage_transfer": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_cancel_object_storage": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_object_storage_bucket": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_object_storage_bucket_access": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_object_storage_keys": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_object_storage_object_url": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.post_object_storage_ssl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.put_object_storage_bucket_acl": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.put_object_storage_key": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ObjectStorageApi.put_storage_bucket_access": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "ProfileApi.get_security_questions": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.delete_vpc": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.delete_vpc_subnet": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpc": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpc_ips": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpc_subnet": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpc_subnets": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpcs": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.get_vpcs_ips": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.post_vpc": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.post_vpc_subnet": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.put_vpc": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
    "VPCsApi.put_vpc_subnet": [
      {
      url: "https://api.linode.com/v4",
      description: "No description provided",
      }
    ],
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



265
266
267
268
269
270
271
272
 
# File 'lib/linode_openapi_client/configuration.rb', line 265

def server_settings
  [
    {
      url: "https://api.linode.com",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/linode_openapi_client/configuration.rb', line 1033

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index.nil? || index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end