ibm_cloud_resource_controller 1.0.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +13 -0
  3. data/.gitignore +13 -0
  4. data/.openapi-generator-ignore +23 -0
  5. data/.openapi-generator/VERSION +1 -0
  6. data/.rspec +3 -0
  7. data/.travis.yml +49 -0
  8. data/CHANGELOG.md +2 -0
  9. data/CODE_OF_CONDUCT.md +76 -0
  10. data/CONTRIBUTING.md +13 -0
  11. data/Gemfile +4 -6
  12. data/LICENSE +201 -0
  13. data/README.md +56 -120
  14. data/Rakefile +3 -7
  15. data/bin/console +14 -0
  16. data/bin/setup +8 -0
  17. data/ibm_cloud_resource_controller.gemspec +34 -37
  18. data/lib/ibm_cloud_resource_controller.rb +9 -64
  19. data/lib/ibm_cloud_resource_controller/authenticators.rb +15 -0
  20. data/lib/ibm_cloud_resource_controller/common.rb +22 -0
  21. data/lib/ibm_cloud_resource_controller/resource_controller_v2.rb +982 -0
  22. data/lib/ibm_cloud_resource_controller/resource_manager_v2.rb +303 -0
  23. data/lib/ibm_cloud_resource_controller/version.rb +1 -13
  24. metadata +59 -145
  25. data/docs/Credentials.md +0 -25
  26. data/docs/ErrorReport.md +0 -23
  27. data/docs/PlanHistoryItem.md +0 -19
  28. data/docs/Reclamation.md +0 -45
  29. data/docs/ReclamationActionsPost.md +0 -19
  30. data/docs/ReclamationsList.md +0 -17
  31. data/docs/ResourceAlias.md +0 -57
  32. data/docs/ResourceAliasPatch.md +0 -17
  33. data/docs/ResourceAliasPost.md +0 -21
  34. data/docs/ResourceAliasesApi.md +0 -302
  35. data/docs/ResourceAliasesList.md +0 -21
  36. data/docs/ResourceBinding.md +0 -57
  37. data/docs/ResourceBindingPatch.md +0 -17
  38. data/docs/ResourceBindingPost.md +0 -25
  39. data/docs/ResourceBindingPostParameters.md +0 -17
  40. data/docs/ResourceBindingsApi.md +0 -300
  41. data/docs/ResourceBindingsList.md +0 -21
  42. data/docs/ResourceInstance.md +0 -81
  43. data/docs/ResourceInstancePatch.md +0 -23
  44. data/docs/ResourceInstancePost.md +0 -29
  45. data/docs/ResourceInstancesApi.md +0 -418
  46. data/docs/ResourceInstancesList.md +0 -21
  47. data/docs/ResourceKey.md +0 -53
  48. data/docs/ResourceKeyPatch.md +0 -17
  49. data/docs/ResourceKeyPost.md +0 -23
  50. data/docs/ResourceKeysApi.md +0 -298
  51. data/docs/ResourceKeysList.md +0 -21
  52. data/docs/ResourceReclamationsApi.md +0 -128
  53. data/git_push.sh +0 -58
  54. data/lib/ibm_cloud_resource_controller/api/resource_aliases_api.rb +0 -363
  55. data/lib/ibm_cloud_resource_controller/api/resource_bindings_api.rb +0 -360
  56. data/lib/ibm_cloud_resource_controller/api/resource_instances_api.rb +0 -493
  57. data/lib/ibm_cloud_resource_controller/api/resource_keys_api.rb +0 -357
  58. data/lib/ibm_cloud_resource_controller/api/resource_reclamations_api.rb +0 -156
  59. data/lib/ibm_cloud_resource_controller/api_client.rb +0 -388
  60. data/lib/ibm_cloud_resource_controller/api_error.rb +0 -57
  61. data/lib/ibm_cloud_resource_controller/configuration.rb +0 -248
  62. data/lib/ibm_cloud_resource_controller/models/credentials.rb +0 -250
  63. data/lib/ibm_cloud_resource_controller/models/error_report.rb +0 -240
  64. data/lib/ibm_cloud_resource_controller/models/plan_history_item.rb +0 -230
  65. data/lib/ibm_cloud_resource_controller/models/reclamation.rb +0 -352
  66. data/lib/ibm_cloud_resource_controller/models/reclamation_actions_post.rb +0 -220
  67. data/lib/ibm_cloud_resource_controller/models/reclamations_list.rb +0 -212
  68. data/lib/ibm_cloud_resource_controller/models/resource_alias.rb +0 -410
  69. data/lib/ibm_cloud_resource_controller/models/resource_alias_patch.rb +0 -236
  70. data/lib/ibm_cloud_resource_controller/models/resource_alias_post.rb +0 -266
  71. data/lib/ibm_cloud_resource_controller/models/resource_aliases_list.rb +0 -247
  72. data/lib/ibm_cloud_resource_controller/models/resource_binding.rb +0 -410
  73. data/lib/ibm_cloud_resource_controller/models/resource_binding_patch.rb +0 -236
  74. data/lib/ibm_cloud_resource_controller/models/resource_binding_post.rb +0 -278
  75. data/lib/ibm_cloud_resource_controller/models/resource_binding_post_parameters.rb +0 -210
  76. data/lib/ibm_cloud_resource_controller/models/resource_bindings_list.rb +0 -247
  77. data/lib/ibm_cloud_resource_controller/models/resource_instance.rb +0 -536
  78. data/lib/ibm_cloud_resource_controller/models/resource_instance_patch.rb +0 -259
  79. data/lib/ibm_cloud_resource_controller/models/resource_instance_post.rb +0 -317
  80. data/lib/ibm_cloud_resource_controller/models/resource_instances_list.rb +0 -247
  81. data/lib/ibm_cloud_resource_controller/models/resource_key.rb +0 -390
  82. data/lib/ibm_cloud_resource_controller/models/resource_key_patch.rb +0 -236
  83. data/lib/ibm_cloud_resource_controller/models/resource_key_post.rb +0 -251
  84. data/lib/ibm_cloud_resource_controller/models/resource_keys_list.rb +0 -247
  85. data/spec/api/resource_aliases_api_spec.rb +0 -104
  86. data/spec/api/resource_bindings_api_spec.rb +0 -103
  87. data/spec/api/resource_instances_api_spec.rb +0 -130
  88. data/spec/api/resource_keys_api_spec.rb +0 -102
  89. data/spec/api/resource_reclamations_api_spec.rb +0 -62
  90. data/spec/api_client_spec.rb +0 -226
  91. data/spec/configuration_spec.rb +0 -42
  92. data/spec/models/credentials_spec.rb +0 -65
  93. data/spec/models/error_report_spec.rb +0 -59
  94. data/spec/models/plan_history_item_spec.rb +0 -47
  95. data/spec/models/reclamation_actions_post_spec.rb +0 -47
  96. data/spec/models/reclamation_spec.rb +0 -125
  97. data/spec/models/reclamations_list_spec.rb +0 -41
  98. data/spec/models/resource_alias_patch_spec.rb +0 -41
  99. data/spec/models/resource_alias_post_spec.rb +0 -53
  100. data/spec/models/resource_alias_spec.rb +0 -143
  101. data/spec/models/resource_aliases_list_spec.rb +0 -53
  102. data/spec/models/resource_binding_patch_spec.rb +0 -41
  103. data/spec/models/resource_binding_post_parameters_spec.rb +0 -41
  104. data/spec/models/resource_binding_post_spec.rb +0 -65
  105. data/spec/models/resource_binding_spec.rb +0 -137
  106. data/spec/models/resource_bindings_list_spec.rb +0 -53
  107. data/spec/models/resource_instance_patch_spec.rb +0 -59
  108. data/spec/models/resource_instance_post_spec.rb +0 -77
  109. data/spec/models/resource_instance_spec.rb +0 -191
  110. data/spec/models/resource_instances_list_spec.rb +0 -53
  111. data/spec/models/resource_key_patch_spec.rb +0 -41
  112. data/spec/models/resource_key_post_spec.rb +0 -59
  113. data/spec/models/resource_key_spec.rb +0 -125
  114. data/spec/models/resource_keys_list_spec.rb +0 -53
  115. data/spec/spec_helper.rb +0 -111
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0458df5ef33bef0ba53f9a8782a997676c792d9a05703546988611e4b8eb1933'
4
- data.tar.gz: f10b207a0bbc10435e005266f635189ac500aeba9e7a24e6b7bebcaa099112ed
3
+ metadata.gz: 662a9efcd9907efad677afee3c152a6bb4d8543f3bc1def9ee59aa9ef966dd2f
4
+ data.tar.gz: 211c243bfff4e13248fd3682040c6feef5f094f08e7bc5625547445e49b33202
5
5
  SHA512:
6
- metadata.gz: 2cec4de6319d878ff2b23b9917c7d19a3e3dd302add5ce9b33d13b6dd3b67001b9757d7591c90936350171e533ad076565f4cd71694cae44bd066e08ee1571fa
7
- data.tar.gz: fbed6f3838dade61f002e7e79860fd0810476cf8c685ea9d21a40f84ae6aaa0ab135c349237260add1241dace02fa52fb5bc299aa5bb410ca3bdfe746335f1d6
6
+ metadata.gz: a78feb8d3345a5f4b8827c6a9f9806748e7cede42ca13a93b1ac956b4af647c8b6e0bbedc6a67581a441fcde209481d5e8d5528fec0f20c72ad507e27e9be45a
7
+ data.tar.gz: 8c48b57365bbcac5dfd78a252fe0d5e5719798e02b248aa125fc4311c2395962a918806fbe224bc1daaa6c67b4c12f381e3b846f66f9886a9e7593b0a03e22bc
data/.bumpversion.cfg ADDED
@@ -0,0 +1,13 @@
1
+ [bumpversion]
2
+ current_version = 0.0.1
3
+ commit = True
4
+ message = Update version {current_version} -> {new_version}
5
+
6
+ [bumpversion:file:lib/ibm_cloud_resource_controller/version.rb]
7
+ search = VERSION = '{current_version}'
8
+ replace = VERSION = '{new_version}'
9
+
10
+ [bumpversion:file:README.md]
11
+ search = {current_version}
12
+ replace = {new_version}
13
+
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /*.gem
2
+ /.bundle/
3
+ /.yardoc
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /Gemfile.lock
11
+
12
+ # rspec failure tracking
13
+ .rspec_status
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
@@ -0,0 +1 @@
1
+ unset
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,49 @@
1
+ language: ruby
2
+ dist: trusty
3
+ cache: bundler
4
+
5
+ notifications:
6
+ email: true
7
+
8
+ matrix:
9
+ fast_finish: true
10
+
11
+ before_install:
12
+ - git fetch --tags
13
+ - sudo apt-get update
14
+ - sudo apt-get install python
15
+ - nvm install node
16
+ - nvm use node
17
+ - gem install bundler:1.16.3
18
+
19
+ install:
20
+ - bundle _1.16.3_ install
21
+
22
+ script:
23
+ - bundle exec rake
24
+
25
+ # To enable semantic-release, uncomment these sections.
26
+ # before_deploy:
27
+ # - pip install --user bumpversion
28
+ # - npm install -g semantic-release
29
+ # - npm install -g @semantic-release/changelog
30
+ # - npm install -g @semantic-release/exec
31
+ # - npm install -g @semantic-release/git
32
+ # - npm install -g @semantic-release/github
33
+ # - npm install -g @semantic-release/commit-analyzer
34
+ #
35
+ # deploy:
36
+ # - provider: script
37
+ # script: npx semantic-release
38
+ # skip_cleanup: true
39
+ # on:
40
+ # branch: master
41
+ # rvm: 2.5.1
42
+ #
43
+ # - provider: rubygems
44
+ # api_key: $RUBYGEMS_API_KEY
45
+ # gem: ibm_cloud_resource_controller
46
+ # on:
47
+ # rvm: '2.5.1'
48
+ # branch: master
49
+ #
data/CHANGELOG.md ADDED
@@ -0,0 +1,2 @@
1
+ = 0.0.1
2
+ * Initial release
@@ -0,0 +1,76 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, sex characteristics, gender identity and expression,
9
+ level of experience, education, socio-economic status, nationality, personal
10
+ appearance, race, religion, or sexual identity and orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at phil_adams@us.ibm.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
+
73
+ [homepage]: https://www.contributor-covenant.org
74
+
75
+ For answers to common questions about this code of conduct, see
76
+ https://www.contributor-covenant.org/faq
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,13 @@
1
+ # Questions
2
+ If you are having problems using the APIs or have a question about IBM Cloud services,
3
+ please ask a question at
4
+ [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
5
+
6
+ # Issues
7
+ If you encounter an issue with the project, you are welcome to submit a
8
+ [bug report](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/issues).
9
+ Before that, please search for similar issues. It's possible that someone has already reported the problem.
10
+
11
+ # General Information
12
+ For general guidance on contributing to this project, please see
13
+ [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_ruby.md)
data/Gemfile CHANGED
@@ -1,9 +1,7 @@
1
- source 'https://rubygems.org'
1
+ source "https://rubygems.org"
2
2
 
3
+ # Specify your gem's dependencies in ibm_cloud_resource_controller.gemspec
3
4
  gemspec
4
5
 
5
- group :development, :test do
6
- gem 'rake', '~> 13.0.1'
7
- gem 'pry-byebug'
8
- gem 'rubocop', '~> 0.66.0'
9
- end
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md CHANGED
@@ -1,148 +1,84 @@
1
- # ibm_cloud_resource_controller
1
+ [![Build Status](https://travis-ci.com/IBM-Cloud/ibm-cloud-sdk-ruby.svg?token=eW5FVD71iyte6tTby8gr&branch=master)](https://travis.ibm.com/IBM-Cloud/ibm-cloud-sdk-ruby)
2
+ [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
3
+ # IBM Cloud Resource Controller Ruby SDK
2
4
 
3
- IbmCloudResourceController - the Ruby gem for the IBM Cloud Resource Controller API
5
+ Ruby client library to interact with various [IBM Cloud Resource Controller APIs](https://cloud.ibm.com/apidocs?category=platform-services).
4
6
 
5
- Manage lifecycle of your Cloud resources using Resource Controller APIs. Resources are provisioned globally in an account scope. Supports asynchronous provisioning of resources. Enables consumption of a global resource through a Cloud Foundry space in any region.
7
+ Disclaimer: this SDK is being released initially as a **pre-release** version.
8
+ Changes might occur which impact applications that use this SDK.
6
9
 
7
- This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
10
+ ## Table of Contents
8
11
 
9
- - API version: 2.0
10
- - Package version: 1.0.0
11
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+ <!--
13
+ The TOC below is generated using the `markdown-toc` node package.
12
14
 
13
- ## Installation
14
-
15
- ### Build a gem
15
+ https://github.com/jonschlinkert/markdown-toc
16
16
 
17
- To build the Ruby code into a gem:
17
+ You should regenerate the TOC after making changes to this file.
18
18
 
19
- ```shell
20
- gem build ibm_cloud_resource_controller.gemspec
21
- ```
19
+ npx markdown-toc -i README.md
20
+ -->
22
21
 
23
- Then either install the gem locally:
22
+ <!-- toc -->
24
23
 
25
- ```shell
26
- gem install ./ibm_cloud_resource_controller-1.0.0.gem
27
- ```
24
+ - [Overview](#overview)
25
+ - [Prerequisites](#prerequisites)
26
+ - [Installation](#installation)
27
+ - [Using the SDK](#using-the-sdk)
28
+ - [Questions](#questions)
29
+ - [Issues](#issues)
30
+ - [Open source @ IBM](#open-source--ibm)
31
+ - [Contributing](#contributing)
32
+ - [License](#license)
28
33
 
29
- (for development, run `gem install --dev ./ibm_cloud_resource_controller-1.0.0.gem` to install the development dependencies)
34
+ <!-- tocstop -->
30
35
 
31
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
36
+ ## Overview
32
37
 
33
- Finally add this to the Gemfile:
38
+ The IBM Cloud Resource Controller Ruby SDK allows developers to programmatically interact with the following
39
+ IBM Cloud services:
34
40
 
35
- gem 'ibm_cloud_resource_controller', '~> 1.0.0'
41
+ Service Name | Imported Class Name
42
+ --- | ---
43
+ <!-- [Example Service](https://cloud.ibm.com/apidocs/example-service) | exampleservicev1 -->
36
44
 
37
- ### Install from Git
45
+ ## Prerequisites
38
46
 
39
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
47
+ [ibm-cloud-onboarding]: https://cloud.ibm.com/registration
40
48
 
41
- gem 'ibm_cloud_resource_controller', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
49
+ * An [IBM Cloud][ibm-cloud-onboarding] account.
50
+ * An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
51
+ * Ruby 2.3.0 or above.
42
52
 
43
- ### Include the Ruby code directly
53
+ ## Installation
44
54
 
45
- Include the Ruby code directly using `-I` as follows:
55
+ To install, use `gem`
46
56
 
47
- ```shell
48
- ruby -Ilib script.rb
57
+ ```bash
58
+ gem install "ibm_cloud_resource_controller"
49
59
  ```
50
60
 
51
- ## Getting Started
52
-
53
- Please follow the [installation](#installation) procedure and then run the following code:
61
+ ## Using the SDK
62
+ For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)
54
63
 
55
- ```ruby
56
- # Load the gem
57
- require 'ibm_cloud_resource_controller'
64
+ ## Questions
58
65
 
59
- # Setup authorization
60
- IbmCloudResourceController.configure do |config|
61
- # Configure API key authorization: IAM
62
- config.api_key['Authorization'] = 'YOUR API KEY'
63
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
64
- #config.api_key_prefix['Authorization'] = 'Bearer'
65
- end
66
+ If you are having difficulties using this SDK or have a question about the IBM Cloud services,
67
+ please ask a question
68
+ [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
66
69
 
67
- api_instance = IbmCloudResourceController::ResourceAliasesApi.new
68
- resource_alias_post = IbmCloudResourceController::ResourceAliasPost.new # ResourceAliasPost |
70
+ ## Issues
71
+ If you encounter an issue with the project, you are welcome to submit a
72
+ [bug report](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/issues).
73
+ Before that, please search for similar issues. It's possible that someone has already reported the problem.
69
74
 
70
- begin
71
- #Create a new resource alias
72
- result = api_instance.create_resource_alias(resource_alias_post)
73
- p result
74
- rescue IbmCloudResourceController::ApiError => e
75
- puts "Exception when calling ResourceAliasesApi->create_resource_alias: #{e}"
76
- end
75
+ ## Open source @ IBM
76
+ Find more open source projects on the [IBM Github Page](http://ibm.github.io/)
77
77
 
78
- ```
78
+ ## Contributing
79
+ See [CONTRIBUTING.md](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/master/CONTRIBUTING.md).
79
80
 
80
- ## Documentation for API Endpoints
81
-
82
- All URIs are relative to *https://resource-controller.cloud.ibm.com*
83
-
84
- Class | Method | HTTP request | Description
85
- ------------ | ------------- | ------------- | -------------
86
- *IbmCloudResourceController::ResourceAliasesApi* | [**create_resource_alias**](docs/ResourceAliasesApi.md#create_resource_alias) | **POST** /v2/resource_aliases | Create a new resource alias
87
- *IbmCloudResourceController::ResourceAliasesApi* | [**delete_resource_alias**](docs/ResourceAliasesApi.md#delete_resource_alias) | **DELETE** /v2/resource_aliases/{id} | Delete a resource alias
88
- *IbmCloudResourceController::ResourceAliasesApi* | [**get_resource_alias**](docs/ResourceAliasesApi.md#get_resource_alias) | **GET** /v2/resource_aliases/{id} | Get a resource alias
89
- *IbmCloudResourceController::ResourceAliasesApi* | [**list_resource_aliases**](docs/ResourceAliasesApi.md#list_resource_aliases) | **GET** /v2/resource_aliases | Get a list of all resource aliases
90
- *IbmCloudResourceController::ResourceAliasesApi* | [**update_resource_alias**](docs/ResourceAliasesApi.md#update_resource_alias) | **PATCH** /v2/resource_aliases/{id} | Update a resource alias
91
- *IbmCloudResourceController::ResourceBindingsApi* | [**create_resource_binding**](docs/ResourceBindingsApi.md#create_resource_binding) | **POST** /v2/resource_bindings | Create a new resource binding
92
- *IbmCloudResourceController::ResourceBindingsApi* | [**delete_resource_binding**](docs/ResourceBindingsApi.md#delete_resource_binding) | **DELETE** /v2/resource_bindings/{id} | Delete a resource binding
93
- *IbmCloudResourceController::ResourceBindingsApi* | [**get_resource_binding**](docs/ResourceBindingsApi.md#get_resource_binding) | **GET** /v2/resource_bindings/{id} | Get a resource binding
94
- *IbmCloudResourceController::ResourceBindingsApi* | [**list_resource_bindings**](docs/ResourceBindingsApi.md#list_resource_bindings) | **GET** /v2/resource_bindings | Get a list of all resource bindings
95
- *IbmCloudResourceController::ResourceBindingsApi* | [**update_resource_binding**](docs/ResourceBindingsApi.md#update_resource_binding) | **PATCH** /v2/resource_bindings/{id} | Update a resource binding
96
- *IbmCloudResourceController::ResourceInstancesApi* | [**create_resource_instance**](docs/ResourceInstancesApi.md#create_resource_instance) | **POST** /v2/resource_instances | Create (provision) a new resource instance
97
- *IbmCloudResourceController::ResourceInstancesApi* | [**delete_resource_instance**](docs/ResourceInstancesApi.md#delete_resource_instance) | **DELETE** /v2/resource_instances/{id} | Delete a resource instance
98
- *IbmCloudResourceController::ResourceInstancesApi* | [**get_resource_instance**](docs/ResourceInstancesApi.md#get_resource_instance) | **GET** /v2/resource_instances/{id} | Get a resource instance
99
- *IbmCloudResourceController::ResourceInstancesApi* | [**list_resource_instances**](docs/ResourceInstancesApi.md#list_resource_instances) | **GET** /v2/resource_instances | Get a list of all resource instances
100
- *IbmCloudResourceController::ResourceInstancesApi* | [**lock_resource_instance**](docs/ResourceInstancesApi.md#lock_resource_instance) | **POST** /v2/resource_instances/{id}/lock | Lock a resource instance
101
- *IbmCloudResourceController::ResourceInstancesApi* | [**unlock_resource_instance**](docs/ResourceInstancesApi.md#unlock_resource_instance) | **DELETE** /v2/resource_instances/{id}/lock | Unlock a resource instance
102
- *IbmCloudResourceController::ResourceInstancesApi* | [**update_resource_instance**](docs/ResourceInstancesApi.md#update_resource_instance) | **PATCH** /v2/resource_instances/{id} | Update a resource instance
103
- *IbmCloudResourceController::ResourceKeysApi* | [**create_resource_key**](docs/ResourceKeysApi.md#create_resource_key) | **POST** /v2/resource_keys | Create a new resource key
104
- *IbmCloudResourceController::ResourceKeysApi* | [**delete_resource_key**](docs/ResourceKeysApi.md#delete_resource_key) | **DELETE** /v2/resource_keys/{id} | Delete a resource key by ID
105
- *IbmCloudResourceController::ResourceKeysApi* | [**get_resource_key**](docs/ResourceKeysApi.md#get_resource_key) | **GET** /v2/resource_keys/{id} | Get resource key by ID
106
- *IbmCloudResourceController::ResourceKeysApi* | [**list_resource_keys**](docs/ResourceKeysApi.md#list_resource_keys) | **GET** /v2/resource_keys | Get a list of all of the resource keys.
107
- *IbmCloudResourceController::ResourceKeysApi* | [**update_resource_key**](docs/ResourceKeysApi.md#update_resource_key) | **PATCH** /v2/resource_keys/{id} | Update a resource key
108
- *IbmCloudResourceController::ResourceReclamationsApi* | [**list_reclamations**](docs/ResourceReclamationsApi.md#list_reclamations) | **GET** /v1/reclamations | Get a list of all reclamations
109
- *IbmCloudResourceController::ResourceReclamationsApi* | [**run_reclamation_action**](docs/ResourceReclamationsApi.md#run_reclamation_action) | **POST** /v1/reclamations/{id}/actions/{action_name} | Perform a reclamation action
110
-
111
-
112
- ## Documentation for Models
113
-
114
- - [IbmCloudResourceController::Credentials](docs/Credentials.md)
115
- - [IbmCloudResourceController::ErrorReport](docs/ErrorReport.md)
116
- - [IbmCloudResourceController::PlanHistoryItem](docs/PlanHistoryItem.md)
117
- - [IbmCloudResourceController::Reclamation](docs/Reclamation.md)
118
- - [IbmCloudResourceController::ReclamationActionsPost](docs/ReclamationActionsPost.md)
119
- - [IbmCloudResourceController::ReclamationsList](docs/ReclamationsList.md)
120
- - [IbmCloudResourceController::ResourceAlias](docs/ResourceAlias.md)
121
- - [IbmCloudResourceController::ResourceAliasPatch](docs/ResourceAliasPatch.md)
122
- - [IbmCloudResourceController::ResourceAliasPost](docs/ResourceAliasPost.md)
123
- - [IbmCloudResourceController::ResourceAliasesList](docs/ResourceAliasesList.md)
124
- - [IbmCloudResourceController::ResourceBinding](docs/ResourceBinding.md)
125
- - [IbmCloudResourceController::ResourceBindingPatch](docs/ResourceBindingPatch.md)
126
- - [IbmCloudResourceController::ResourceBindingPost](docs/ResourceBindingPost.md)
127
- - [IbmCloudResourceController::ResourceBindingPostParameters](docs/ResourceBindingPostParameters.md)
128
- - [IbmCloudResourceController::ResourceBindingsList](docs/ResourceBindingsList.md)
129
- - [IbmCloudResourceController::ResourceInstance](docs/ResourceInstance.md)
130
- - [IbmCloudResourceController::ResourceInstancePatch](docs/ResourceInstancePatch.md)
131
- - [IbmCloudResourceController::ResourceInstancePost](docs/ResourceInstancePost.md)
132
- - [IbmCloudResourceController::ResourceInstancesList](docs/ResourceInstancesList.md)
133
- - [IbmCloudResourceController::ResourceKey](docs/ResourceKey.md)
134
- - [IbmCloudResourceController::ResourceKeyPatch](docs/ResourceKeyPatch.md)
135
- - [IbmCloudResourceController::ResourceKeyPost](docs/ResourceKeyPost.md)
136
- - [IbmCloudResourceController::ResourceKeysList](docs/ResourceKeysList.md)
137
-
138
-
139
- ## Documentation for Authorization
140
-
141
-
142
- ### IAM
143
-
144
-
145
- - **Type**: API key
146
- - **API key parameter name**: Authorization
147
- - **Location**: HTTP header
81
+ ## License
148
82
 
83
+ This SDK is released under the Apache 2.0 license.
84
+ The license's full text can be found in [LICENSE](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/master/LICENSE).