autosde_openapi_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +207 -0
  4. data/Rakefile +10 -0
  5. data/autosde_openapi_client.gemspec +39 -0
  6. data/docs/AbstractCapability.md +19 -0
  7. data/docs/AbstractCapabilityApi.md +204 -0
  8. data/docs/Account.md +21 -0
  9. data/docs/AccountApi.md +256 -0
  10. data/docs/AccountPostRequest.md +19 -0
  11. data/docs/AccountPostResponse.md +23 -0
  12. data/docs/Address.md +31 -0
  13. data/docs/AddressApi.md +204 -0
  14. data/docs/AddressCreate.md +31 -0
  15. data/docs/AuthResponse.md +17 -0
  16. data/docs/Authentication.md +19 -0
  17. data/docs/AuthenticationApi.md +53 -0
  18. data/docs/AutoSDEProject.md +55 -0
  19. data/docs/AutoSDEProjectApi.md +204 -0
  20. data/docs/AutoSDERole.md +19 -0
  21. data/docs/AutoSDERoleApi.md +204 -0
  22. data/docs/CapabilityTranslation.md +35 -0
  23. data/docs/CapabilityTranslationApi.md +204 -0
  24. data/docs/CapabilityTranslationCreate.md +31 -0
  25. data/docs/Host.md +29 -0
  26. data/docs/HostApi.md +204 -0
  27. data/docs/HostCreate.md +39 -0
  28. data/docs/HostVolumeConnection.md +23 -0
  29. data/docs/HostVolumeConnectionApi.md +204 -0
  30. data/docs/HostVolumeConnectionCreate.md +21 -0
  31. data/docs/NativeCapability.md +23 -0
  32. data/docs/NativeCapabilityApi.md +204 -0
  33. data/docs/Profile.md +25 -0
  34. data/docs/ProfileApi.md +204 -0
  35. data/docs/ProvisioningStrategy.md +19 -0
  36. data/docs/ProvisioningStrategyApi.md +204 -0
  37. data/docs/Service.md +35 -0
  38. data/docs/ServiceAbstractCapabilityValue.md +21 -0
  39. data/docs/ServiceApi.md +256 -0
  40. data/docs/ServiceCreate.md +33 -0
  41. data/docs/ServiceResourceAttachment.md +23 -0
  42. data/docs/ServiceResourceAttachmentApi.md +204 -0
  43. data/docs/StorageResource.md +33 -0
  44. data/docs/StorageResourceApi.md +256 -0
  45. data/docs/StorageResourceCreate.md +31 -0
  46. data/docs/StorageResourceResponse.md +33 -0
  47. data/docs/StorageSystem.md +29 -0
  48. data/docs/StorageSystemApi.md +204 -0
  49. data/docs/StorageSystemCreate.md +49 -0
  50. data/docs/SystemType.md +25 -0
  51. data/docs/SystemTypeApi.md +204 -0
  52. data/docs/SystemTypeCreate.md +27 -0
  53. data/docs/Volume.md +31 -0
  54. data/docs/VolumeApi.md +256 -0
  55. data/docs/VolumeCreate.md +27 -0
  56. data/docs/VolumeResponse.md +31 -0
  57. data/docs/VolumeSafeDelete.md +21 -0
  58. data/docs/VolumeSafeDeleteApi.md +204 -0
  59. data/docs/VolumeSafeDeleteCreate.md +17 -0
  60. data/docs/VolumeUpdate.md +17 -0
  61. data/git_push.sh +58 -0
  62. data/lib/autosde_openapi_client.rb +94 -0
  63. data/lib/autosde_openapi_client/api/abstract_capability_api.rb +250 -0
  64. data/lib/autosde_openapi_client/api/account_api.rb +316 -0
  65. data/lib/autosde_openapi_client/api/address_api.rb +250 -0
  66. data/lib/autosde_openapi_client/api/authentication_api.rb +82 -0
  67. data/lib/autosde_openapi_client/api/auto_sde_project_api.rb +250 -0
  68. data/lib/autosde_openapi_client/api/auto_sde_role_api.rb +250 -0
  69. data/lib/autosde_openapi_client/api/capability_translation_api.rb +250 -0
  70. data/lib/autosde_openapi_client/api/host_api.rb +250 -0
  71. data/lib/autosde_openapi_client/api/host_volume_connection_api.rb +250 -0
  72. data/lib/autosde_openapi_client/api/native_capability_api.rb +250 -0
  73. data/lib/autosde_openapi_client/api/profile_api.rb +250 -0
  74. data/lib/autosde_openapi_client/api/provisioning_strategy_api.rb +250 -0
  75. data/lib/autosde_openapi_client/api/service_api.rb +316 -0
  76. data/lib/autosde_openapi_client/api/service_resource_attachment_api.rb +250 -0
  77. data/lib/autosde_openapi_client/api/storage_resource_api.rb +316 -0
  78. data/lib/autosde_openapi_client/api/storage_system_api.rb +250 -0
  79. data/lib/autosde_openapi_client/api/system_type_api.rb +250 -0
  80. data/lib/autosde_openapi_client/api/volume_api.rb +316 -0
  81. data/lib/autosde_openapi_client/api/volume_safe_delete_api.rb +250 -0
  82. data/lib/autosde_openapi_client/api_client.rb +388 -0
  83. data/lib/autosde_openapi_client/api_error.rb +57 -0
  84. data/lib/autosde_openapi_client/configuration.rb +266 -0
  85. data/lib/autosde_openapi_client/models/abstract_capability.rb +218 -0
  86. data/lib/autosde_openapi_client/models/account.rb +228 -0
  87. data/lib/autosde_openapi_client/models/account_post_request.rb +218 -0
  88. data/lib/autosde_openapi_client/models/account_post_response.rb +238 -0
  89. data/lib/autosde_openapi_client/models/address.rb +328 -0
  90. data/lib/autosde_openapi_client/models/address_create.rb +330 -0
  91. data/lib/autosde_openapi_client/models/auth_response.rb +208 -0
  92. data/lib/autosde_openapi_client/models/authentication.rb +218 -0
  93. data/lib/autosde_openapi_client/models/auto_sde_project.rb +398 -0
  94. data/lib/autosde_openapi_client/models/auto_sde_role.rb +218 -0
  95. data/lib/autosde_openapi_client/models/capability_translation.rb +328 -0
  96. data/lib/autosde_openapi_client/models/capability_translation_create.rb +310 -0
  97. data/lib/autosde_openapi_client/models/host.rb +321 -0
  98. data/lib/autosde_openapi_client/models/host_create.rb +382 -0
  99. data/lib/autosde_openapi_client/models/host_volume_connection.rb +275 -0
  100. data/lib/autosde_openapi_client/models/host_volume_connection_create.rb +265 -0
  101. data/lib/autosde_openapi_client/models/native_capability.rb +239 -0
  102. data/lib/autosde_openapi_client/models/profile.rb +283 -0
  103. data/lib/autosde_openapi_client/models/provisioning_strategy.rb +257 -0
  104. data/lib/autosde_openapi_client/models/service.rb +339 -0
  105. data/lib/autosde_openapi_client/models/service_abstract_capability_value.rb +227 -0
  106. data/lib/autosde_openapi_client/models/service_create.rb +327 -0
  107. data/lib/autosde_openapi_client/models/service_resource_attachment.rb +238 -0
  108. data/lib/autosde_openapi_client/models/storage_resource.rb +342 -0
  109. data/lib/autosde_openapi_client/models/storage_resource_create.rb +333 -0
  110. data/lib/autosde_openapi_client/models/storage_resource_response.rb +343 -0
  111. data/lib/autosde_openapi_client/models/storage_system.rb +333 -0
  112. data/lib/autosde_openapi_client/models/storage_system_create.rb +448 -0
  113. data/lib/autosde_openapi_client/models/system_type.rb +321 -0
  114. data/lib/autosde_openapi_client/models/system_type_create.rb +333 -0
  115. data/lib/autosde_openapi_client/models/volume.rb +316 -0
  116. data/lib/autosde_openapi_client/models/volume_create.rb +299 -0
  117. data/lib/autosde_openapi_client/models/volume_response.rb +318 -0
  118. data/lib/autosde_openapi_client/models/volume_safe_delete.rb +227 -0
  119. data/lib/autosde_openapi_client/models/volume_safe_delete_create.rb +207 -0
  120. data/lib/autosde_openapi_client/models/volume_update.rb +208 -0
  121. data/lib/autosde_openapi_client/version.rb +15 -0
  122. data/site_manager_oas.json +3992 -0
  123. data/spec/api/abstract_capability_api_spec.rb +74 -0
  124. data/spec/api/account_api_spec.rb +85 -0
  125. data/spec/api/address_api_spec.rb +74 -0
  126. data/spec/api/authentication_api_spec.rb +45 -0
  127. data/spec/api/auto_sde_project_api_spec.rb +74 -0
  128. data/spec/api/auto_sde_role_api_spec.rb +74 -0
  129. data/spec/api/capability_translation_api_spec.rb +74 -0
  130. data/spec/api/host_api_spec.rb +74 -0
  131. data/spec/api/host_volume_connection_api_spec.rb +74 -0
  132. data/spec/api/native_capability_api_spec.rb +74 -0
  133. data/spec/api/profile_api_spec.rb +74 -0
  134. data/spec/api/provisioning_strategy_api_spec.rb +74 -0
  135. data/spec/api/service_api_spec.rb +85 -0
  136. data/spec/api/service_resource_attachment_api_spec.rb +74 -0
  137. data/spec/api/storage_resource_api_spec.rb +85 -0
  138. data/spec/api/storage_system_api_spec.rb +74 -0
  139. data/spec/api/system_type_api_spec.rb +74 -0
  140. data/spec/api/volume_api_spec.rb +85 -0
  141. data/spec/api/volume_safe_delete_api_spec.rb +74 -0
  142. data/spec/api_client_spec.rb +226 -0
  143. data/spec/configuration_spec.rb +42 -0
  144. data/spec/models/abstract_capability_spec.rb +47 -0
  145. data/spec/models/account_post_request_spec.rb +47 -0
  146. data/spec/models/account_post_response_spec.rb +59 -0
  147. data/spec/models/account_spec.rb +53 -0
  148. data/spec/models/address_create_spec.rb +91 -0
  149. data/spec/models/address_spec.rb +91 -0
  150. data/spec/models/auth_response_spec.rb +41 -0
  151. data/spec/models/authentication_spec.rb +47 -0
  152. data/spec/models/auto_sde_project_spec.rb +155 -0
  153. data/spec/models/auto_sde_role_spec.rb +47 -0
  154. data/spec/models/capability_translation_create_spec.rb +83 -0
  155. data/spec/models/capability_translation_spec.rb +95 -0
  156. data/spec/models/host_create_spec.rb +119 -0
  157. data/spec/models/host_spec.rb +85 -0
  158. data/spec/models/host_volume_connection_create_spec.rb +57 -0
  159. data/spec/models/host_volume_connection_spec.rb +63 -0
  160. data/spec/models/native_capability_spec.rb +59 -0
  161. data/spec/models/profile_spec.rb +69 -0
  162. data/spec/models/provisioning_strategy_spec.rb +51 -0
  163. data/spec/models/service_abstract_capability_value_spec.rb +53 -0
  164. data/spec/models/service_create_spec.rb +93 -0
  165. data/spec/models/service_resource_attachment_spec.rb +59 -0
  166. data/spec/models/service_spec.rb +99 -0
  167. data/spec/models/storage_resource_create_spec.rb +91 -0
  168. data/spec/models/storage_resource_response_spec.rb +97 -0
  169. data/spec/models/storage_resource_spec.rb +97 -0
  170. data/spec/models/storage_system_create_spec.rb +149 -0
  171. data/spec/models/storage_system_spec.rb +85 -0
  172. data/spec/models/system_type_create_spec.rb +79 -0
  173. data/spec/models/system_type_spec.rb +73 -0
  174. data/spec/models/volume_create_spec.rb +75 -0
  175. data/spec/models/volume_response_spec.rb +87 -0
  176. data/spec/models/volume_safe_delete_create_spec.rb +41 -0
  177. data/spec/models/volume_safe_delete_spec.rb +53 -0
  178. data/spec/models/volume_spec.rb +87 -0
  179. data/spec/models/volume_update_spec.rb +41 -0
  180. data/spec/spec_helper.rb +111 -0
  181. metadata +340 -0
@@ -0,0 +1,49 @@
1
+ # OpenapiClient::StorageSystemCreate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **auto_add_pools** | **Boolean** | auto_add_pools | [optional] [default to false]
8
+ **auto_setup** | **Boolean** | auto_setup | [optional] [default to false]
9
+ **chap_name** | **String** | chap_name | [optional]
10
+ **chap_secret** | **String** | chap_secret | [optional]
11
+ **component_state** | **String** | component_state | [optional]
12
+ **iqn** | **String** | | [optional]
13
+ **management_ip** | **String** | management_ip | [optional]
14
+ **name** | **String** | name | [optional]
15
+ **password** | **String** | password | [optional]
16
+ **port_type** | **String** | port_type | [optional]
17
+ **secondary_ip** | **String** | secondary_ip | [optional]
18
+ **storage_array** | **String** | storage_array | [optional]
19
+ **storage_driver** | **String** | storage_driver | [optional]
20
+ **storage_family** | **String** | storage_family | [optional]
21
+ **system_type** | [**SystemType**](SystemType.md) | | [optional]
22
+ **user** | **String** | user | [optional]
23
+ **wwpn** | **String** | wwpn | [optional]
24
+
25
+ ## Code Sample
26
+
27
+ ```ruby
28
+ require 'OpenapiClient'
29
+
30
+ instance = OpenapiClient::StorageSystemCreate.new(auto_add_pools: null,
31
+ auto_setup: null,
32
+ chap_name: null,
33
+ chap_secret: null,
34
+ component_state: null,
35
+ iqn: null,
36
+ management_ip: null,
37
+ name: null,
38
+ password: null,
39
+ port_type: null,
40
+ secondary_ip: null,
41
+ storage_array: null,
42
+ storage_driver: null,
43
+ storage_family: null,
44
+ system_type: null,
45
+ user: null,
46
+ wwpn: null)
47
+ ```
48
+
49
+
@@ -0,0 +1,25 @@
1
+ # OpenapiClient::SystemType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **component_state** | **String** | component_state | [optional]
8
+ **name** | **String** | name | [optional] [default to 'xiv']
9
+ **short_version** | **String** | short_version | [optional]
10
+ **uuid** | **String** | uuid | [optional]
11
+ **version** | **String** | SystemType version | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'OpenapiClient'
17
+
18
+ instance = OpenapiClient::SystemType.new(component_state: null,
19
+ name: null,
20
+ short_version: null,
21
+ uuid: null,
22
+ version: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,204 @@
1
+ # OpenapiClient::SystemTypeApi
2
+
3
+ All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**system_types_get**](SystemTypeApi.md#system_types_get) | **GET** /system-types/ |
8
+ [**system_types_pk_delete**](SystemTypeApi.md#system_types_pk_delete) | **DELETE** /system-types/{pk} |
9
+ [**system_types_pk_get**](SystemTypeApi.md#system_types_pk_get) | **GET** /system-types/{pk} |
10
+ [**system_types_post**](SystemTypeApi.md#system_types_post) | **POST** /system-types/ |
11
+
12
+
13
+
14
+ ## system_types_get
15
+
16
+ > Array<SystemType> system_types_get
17
+
18
+
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'autosde_openapi_client'
25
+ # setup authorization
26
+ OpenapiClient.configure do |config|
27
+ # Configure Bearer authorization: bearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+ end
30
+
31
+ api_instance = OpenapiClient::SystemTypeApi.new
32
+
33
+ begin
34
+ result = api_instance.system_types_get
35
+ p result
36
+ rescue OpenapiClient::ApiError => e
37
+ puts "Exception when calling SystemTypeApi->system_types_get: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ This endpoint does not need any parameter.
44
+
45
+ ### Return type
46
+
47
+ [**Array<SystemType>**](SystemType.md)
48
+
49
+ ### Authorization
50
+
51
+ [bearerAuth](../README.md#bearerAuth)
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: */*
57
+
58
+
59
+ ## system_types_pk_delete
60
+
61
+ > Array<SystemType> system_types_pk_delete(pk)
62
+
63
+
64
+
65
+ ### Example
66
+
67
+ ```ruby
68
+ # load the gem
69
+ require 'autosde_openapi_client'
70
+ # setup authorization
71
+ OpenapiClient.configure do |config|
72
+ # Configure Bearer authorization: bearerAuth
73
+ config.access_token = 'YOUR_BEARER_TOKEN'
74
+ end
75
+
76
+ api_instance = OpenapiClient::SystemTypeApi.new
77
+ pk = 56 # Integer |
78
+
79
+ begin
80
+ result = api_instance.system_types_pk_delete(pk)
81
+ p result
82
+ rescue OpenapiClient::ApiError => e
83
+ puts "Exception when calling SystemTypeApi->system_types_pk_delete: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+
90
+ Name | Type | Description | Notes
91
+ ------------- | ------------- | ------------- | -------------
92
+ **pk** | **Integer**| |
93
+
94
+ ### Return type
95
+
96
+ [**Array<SystemType>**](SystemType.md)
97
+
98
+ ### Authorization
99
+
100
+ [bearerAuth](../README.md#bearerAuth)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: */*
106
+
107
+
108
+ ## system_types_pk_get
109
+
110
+ > Array<SystemType> system_types_pk_get(pk)
111
+
112
+
113
+
114
+ ### Example
115
+
116
+ ```ruby
117
+ # load the gem
118
+ require 'autosde_openapi_client'
119
+ # setup authorization
120
+ OpenapiClient.configure do |config|
121
+ # Configure Bearer authorization: bearerAuth
122
+ config.access_token = 'YOUR_BEARER_TOKEN'
123
+ end
124
+
125
+ api_instance = OpenapiClient::SystemTypeApi.new
126
+ pk = 56 # Integer |
127
+
128
+ begin
129
+ result = api_instance.system_types_pk_get(pk)
130
+ p result
131
+ rescue OpenapiClient::ApiError => e
132
+ puts "Exception when calling SystemTypeApi->system_types_pk_get: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+
139
+ Name | Type | Description | Notes
140
+ ------------- | ------------- | ------------- | -------------
141
+ **pk** | **Integer**| |
142
+
143
+ ### Return type
144
+
145
+ [**Array<SystemType>**](SystemType.md)
146
+
147
+ ### Authorization
148
+
149
+ [bearerAuth](../README.md#bearerAuth)
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: Not defined
154
+ - **Accept**: */*
155
+
156
+
157
+ ## system_types_post
158
+
159
+ > Array<SystemType> system_types_post(system_type_create)
160
+
161
+
162
+
163
+ ### Example
164
+
165
+ ```ruby
166
+ # load the gem
167
+ require 'autosde_openapi_client'
168
+ # setup authorization
169
+ OpenapiClient.configure do |config|
170
+ # Configure Bearer authorization: bearerAuth
171
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
+ end
173
+
174
+ api_instance = OpenapiClient::SystemTypeApi.new
175
+ system_type_create = OpenapiClient::SystemTypeCreate.new # SystemTypeCreate |
176
+
177
+ begin
178
+ result = api_instance.system_types_post(system_type_create)
179
+ p result
180
+ rescue OpenapiClient::ApiError => e
181
+ puts "Exception when calling SystemTypeApi->system_types_post: #{e}"
182
+ end
183
+ ```
184
+
185
+ ### Parameters
186
+
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **system_type_create** | [**SystemTypeCreate**](SystemTypeCreate.md)| |
191
+
192
+ ### Return type
193
+
194
+ [**Array<SystemType>**](SystemType.md)
195
+
196
+ ### Authorization
197
+
198
+ [bearerAuth](../README.md#bearerAuth)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: application/json
203
+ - **Accept**: */*
204
+
@@ -0,0 +1,27 @@
1
+ # OpenapiClient::SystemTypeCreate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **component_state** | **String** | component_state | [optional]
8
+ **name** | **String** | name | [optional] [default to 'xiv']
9
+ **short_version** | **String** | short_version | [optional]
10
+ **super_type** | **String** | super_type | [optional] [default to 'null']
11
+ **uuid** | **String** | uuid | [optional]
12
+ **version** | **String** | SystemType version | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'OpenapiClient'
18
+
19
+ instance = OpenapiClient::SystemTypeCreate.new(component_state: null,
20
+ name: null,
21
+ short_version: null,
22
+ super_type: null,
23
+ uuid: null,
24
+ version: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,31 @@
1
+ # OpenapiClient::Volume
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **compliant** | **Boolean** | compliant | [optional] [default to false]
8
+ **component_state** | **String** | component_state | [optional]
9
+ **historical_service** | [**Service**](Service.md) | | [optional]
10
+ **name** | **String** | name | [optional]
11
+ **service** | [**Service**](Service.md) | | [optional]
12
+ **size** | **Integer** | size | [optional]
13
+ **storage_resource** | [**StorageResource**](StorageResource.md) | | [optional]
14
+ **uuid** | **String** | uuid | [optional]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'OpenapiClient'
20
+
21
+ instance = OpenapiClient::Volume.new(compliant: null,
22
+ component_state: null,
23
+ historical_service: null,
24
+ name: null,
25
+ service: null,
26
+ size: null,
27
+ storage_resource: null,
28
+ uuid: null)
29
+ ```
30
+
31
+
@@ -0,0 +1,256 @@
1
+ # OpenapiClient::VolumeApi
2
+
3
+ All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**volumes_get**](VolumeApi.md#volumes_get) | **GET** /volumes/ |
8
+ [**volumes_pk_delete**](VolumeApi.md#volumes_pk_delete) | **DELETE** /volumes/{pk} |
9
+ [**volumes_pk_get**](VolumeApi.md#volumes_pk_get) | **GET** /volumes/{pk} |
10
+ [**volumes_pk_put**](VolumeApi.md#volumes_pk_put) | **PUT** /volumes/{pk} |
11
+ [**volumes_post**](VolumeApi.md#volumes_post) | **POST** /volumes/ |
12
+
13
+
14
+
15
+ ## volumes_get
16
+
17
+ > Array<VolumeResponse> volumes_get
18
+
19
+
20
+
21
+ ### Example
22
+
23
+ ```ruby
24
+ # load the gem
25
+ require 'autosde_openapi_client'
26
+ # setup authorization
27
+ OpenapiClient.configure do |config|
28
+ # Configure Bearer authorization: bearerAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+ end
31
+
32
+ api_instance = OpenapiClient::VolumeApi.new
33
+
34
+ begin
35
+ result = api_instance.volumes_get
36
+ p result
37
+ rescue OpenapiClient::ApiError => e
38
+ puts "Exception when calling VolumeApi->volumes_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ This endpoint does not need any parameter.
45
+
46
+ ### Return type
47
+
48
+ [**Array<VolumeResponse>**](VolumeResponse.md)
49
+
50
+ ### Authorization
51
+
52
+ [bearerAuth](../README.md#bearerAuth)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: Not defined
57
+ - **Accept**: */*
58
+
59
+
60
+ ## volumes_pk_delete
61
+
62
+ > Array<Volume> volumes_pk_delete(pk)
63
+
64
+
65
+
66
+ ### Example
67
+
68
+ ```ruby
69
+ # load the gem
70
+ require 'autosde_openapi_client'
71
+ # setup authorization
72
+ OpenapiClient.configure do |config|
73
+ # Configure Bearer authorization: bearerAuth
74
+ config.access_token = 'YOUR_BEARER_TOKEN'
75
+ end
76
+
77
+ api_instance = OpenapiClient::VolumeApi.new
78
+ pk = 56 # Integer |
79
+
80
+ begin
81
+ result = api_instance.volumes_pk_delete(pk)
82
+ p result
83
+ rescue OpenapiClient::ApiError => e
84
+ puts "Exception when calling VolumeApi->volumes_pk_delete: #{e}"
85
+ end
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **pk** | **Integer**| |
94
+
95
+ ### Return type
96
+
97
+ [**Array<Volume>**](Volume.md)
98
+
99
+ ### Authorization
100
+
101
+ [bearerAuth](../README.md#bearerAuth)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: Not defined
106
+ - **Accept**: */*
107
+
108
+
109
+ ## volumes_pk_get
110
+
111
+ > Array<VolumeResponse> volumes_pk_get(pk)
112
+
113
+
114
+
115
+ ### Example
116
+
117
+ ```ruby
118
+ # load the gem
119
+ require 'autosde_openapi_client'
120
+ # setup authorization
121
+ OpenapiClient.configure do |config|
122
+ # Configure Bearer authorization: bearerAuth
123
+ config.access_token = 'YOUR_BEARER_TOKEN'
124
+ end
125
+
126
+ api_instance = OpenapiClient::VolumeApi.new
127
+ pk = 56 # Integer |
128
+
129
+ begin
130
+ result = api_instance.volumes_pk_get(pk)
131
+ p result
132
+ rescue OpenapiClient::ApiError => e
133
+ puts "Exception when calling VolumeApi->volumes_pk_get: #{e}"
134
+ end
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+
140
+ Name | Type | Description | Notes
141
+ ------------- | ------------- | ------------- | -------------
142
+ **pk** | **Integer**| |
143
+
144
+ ### Return type
145
+
146
+ [**Array<VolumeResponse>**](VolumeResponse.md)
147
+
148
+ ### Authorization
149
+
150
+ [bearerAuth](../README.md#bearerAuth)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: */*
156
+
157
+
158
+ ## volumes_pk_put
159
+
160
+ > Array<VolumeResponse> volumes_pk_put(pk, volume_update)
161
+
162
+
163
+
164
+ ### Example
165
+
166
+ ```ruby
167
+ # load the gem
168
+ require 'autosde_openapi_client'
169
+ # setup authorization
170
+ OpenapiClient.configure do |config|
171
+ # Configure Bearer authorization: bearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
173
+ end
174
+
175
+ api_instance = OpenapiClient::VolumeApi.new
176
+ pk = 56 # Integer |
177
+ volume_update = OpenapiClient::VolumeUpdate.new # VolumeUpdate |
178
+
179
+ begin
180
+ result = api_instance.volumes_pk_put(pk, volume_update)
181
+ p result
182
+ rescue OpenapiClient::ApiError => e
183
+ puts "Exception when calling VolumeApi->volumes_pk_put: #{e}"
184
+ end
185
+ ```
186
+
187
+ ### Parameters
188
+
189
+
190
+ Name | Type | Description | Notes
191
+ ------------- | ------------- | ------------- | -------------
192
+ **pk** | **Integer**| |
193
+ **volume_update** | [**VolumeUpdate**](VolumeUpdate.md)| |
194
+
195
+ ### Return type
196
+
197
+ [**Array<VolumeResponse>**](VolumeResponse.md)
198
+
199
+ ### Authorization
200
+
201
+ [bearerAuth](../README.md#bearerAuth)
202
+
203
+ ### HTTP request headers
204
+
205
+ - **Content-Type**: application/json
206
+ - **Accept**: */*
207
+
208
+
209
+ ## volumes_post
210
+
211
+ > Array<VolumeResponse> volumes_post(volume_create)
212
+
213
+
214
+
215
+ ### Example
216
+
217
+ ```ruby
218
+ # load the gem
219
+ require 'autosde_openapi_client'
220
+ # setup authorization
221
+ OpenapiClient.configure do |config|
222
+ # Configure Bearer authorization: bearerAuth
223
+ config.access_token = 'YOUR_BEARER_TOKEN'
224
+ end
225
+
226
+ api_instance = OpenapiClient::VolumeApi.new
227
+ volume_create = OpenapiClient::VolumeCreate.new # VolumeCreate |
228
+
229
+ begin
230
+ result = api_instance.volumes_post(volume_create)
231
+ p result
232
+ rescue OpenapiClient::ApiError => e
233
+ puts "Exception when calling VolumeApi->volumes_post: #{e}"
234
+ end
235
+ ```
236
+
237
+ ### Parameters
238
+
239
+
240
+ Name | Type | Description | Notes
241
+ ------------- | ------------- | ------------- | -------------
242
+ **volume_create** | [**VolumeCreate**](VolumeCreate.md)| |
243
+
244
+ ### Return type
245
+
246
+ [**Array<VolumeResponse>**](VolumeResponse.md)
247
+
248
+ ### Authorization
249
+
250
+ [bearerAuth](../README.md#bearerAuth)
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: application/json
255
+ - **Accept**: */*
256
+