autosde_openapi_client 1.0.2 → 1.0.3

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 (219) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +146 -146
  3. data/autosde_openapi_client.gemspec +2 -2
  4. data/docs/AbstractCapability.md +11 -10
  5. data/docs/AbstractCapabilityApi.md +121 -49
  6. data/docs/Account.md +13 -12
  7. data/docs/AccountApi.md +153 -63
  8. data/docs/AccountPostRequest.md +11 -10
  9. data/docs/AccountPostResponse.md +15 -14
  10. data/docs/Address.md +23 -22
  11. data/docs/AddressApi.md +121 -49
  12. data/docs/AddressCreate.md +23 -22
  13. data/docs/AuthResponse.md +9 -8
  14. data/docs/Authentication.md +11 -10
  15. data/docs/AuthenticationApi.md +33 -16
  16. data/docs/AutoSDEProject.md +47 -46
  17. data/docs/AutoSDEProjectApi.md +121 -49
  18. data/docs/AutoSDERole.md +11 -10
  19. data/docs/AutoSDERoleApi.md +121 -49
  20. data/docs/CapabilityTranslation.md +27 -26
  21. data/docs/CapabilityTranslationApi.md +121 -49
  22. data/docs/CapabilityTranslationCreate.md +23 -22
  23. data/docs/Host.md +21 -20
  24. data/docs/HostApi.md +121 -49
  25. data/docs/HostCreate.md +31 -30
  26. data/docs/HostVolumeConnection.md +15 -14
  27. data/docs/HostVolumeConnectionApi.md +121 -49
  28. data/docs/HostVolumeConnectionCreate.md +13 -12
  29. data/docs/Job.md +21 -20
  30. data/docs/JobApi.md +61 -25
  31. data/docs/JobCreate.md +11 -10
  32. data/docs/NativeCapability.md +15 -14
  33. data/docs/NativeCapabilityApi.md +121 -49
  34. data/docs/Profile.md +17 -16
  35. data/docs/ProfileApi.md +121 -49
  36. data/docs/ProvisioningStrategy.md +11 -10
  37. data/docs/ProvisioningStrategyApi.md +121 -49
  38. data/docs/Service.md +27 -26
  39. data/docs/ServiceAbstractCapabilityValue.md +13 -12
  40. data/docs/ServiceApi.md +153 -63
  41. data/docs/ServiceCreate.md +25 -24
  42. data/docs/ServiceResourceAttachment.md +15 -14
  43. data/docs/ServiceResourceAttachmentApi.md +121 -49
  44. data/docs/Snapshot.md +17 -16
  45. data/docs/SnapshotApi.md +121 -49
  46. data/docs/SnapshotCreate.md +15 -14
  47. data/docs/StorageHost.md +21 -20
  48. data/docs/StorageHostApi.md +153 -63
  49. data/docs/StorageHostCreate.md +29 -28
  50. data/docs/StorageHostResponse.md +23 -22
  51. data/docs/StorageHostUpdate.md +13 -12
  52. data/docs/StorageHostVolumeMapping.md +17 -16
  53. data/docs/StorageHostVolumeMappingApi.md +121 -49
  54. data/docs/StorageHostVolumeMappingCreate.md +15 -14
  55. data/docs/StorageResource.md +25 -24
  56. data/docs/StorageResourceApi.md +153 -63
  57. data/docs/StorageResourceCreate.md +23 -22
  58. data/docs/StorageResourceResponse.md +25 -24
  59. data/docs/StorageSystem.md +21 -20
  60. data/docs/StorageSystemApi.md +121 -49
  61. data/docs/StorageSystemCreate.md +41 -40
  62. data/docs/SystemType.md +17 -16
  63. data/docs/SystemTypeApi.md +121 -49
  64. data/docs/SystemTypeCreate.md +19 -18
  65. data/docs/Volume.md +25 -24
  66. data/docs/VolumeApi.md +153 -63
  67. data/docs/VolumeCreate.md +21 -20
  68. data/docs/VolumeResponse.md +25 -24
  69. data/docs/VolumeSafeDelete.md +13 -12
  70. data/docs/VolumeSafeDeleteApi.md +121 -49
  71. data/docs/VolumeSafeDeleteCreate.md +9 -8
  72. data/docs/VolumeUpdate.md +11 -10
  73. data/lib/autosde_openapi_client.rb +3 -3
  74. data/lib/autosde_openapi_client/api/abstract_capability_api.rb +2 -2
  75. data/lib/autosde_openapi_client/api/account_api.rb +2 -2
  76. data/lib/autosde_openapi_client/api/address_api.rb +2 -2
  77. data/lib/autosde_openapi_client/api/authentication_api.rb +2 -2
  78. data/lib/autosde_openapi_client/api/auto_sde_project_api.rb +2 -2
  79. data/lib/autosde_openapi_client/api/auto_sde_role_api.rb +2 -2
  80. data/lib/autosde_openapi_client/api/capability_translation_api.rb +2 -2
  81. data/lib/autosde_openapi_client/api/host_api.rb +2 -2
  82. data/lib/autosde_openapi_client/api/host_volume_connection_api.rb +2 -2
  83. data/lib/autosde_openapi_client/api/job_api.rb +2 -2
  84. data/lib/autosde_openapi_client/api/native_capability_api.rb +2 -2
  85. data/lib/autosde_openapi_client/api/profile_api.rb +2 -2
  86. data/lib/autosde_openapi_client/api/provisioning_strategy_api.rb +2 -2
  87. data/lib/autosde_openapi_client/api/service_api.rb +2 -2
  88. data/lib/autosde_openapi_client/api/service_resource_attachment_api.rb +2 -2
  89. data/lib/autosde_openapi_client/api/snapshot_api.rb +2 -2
  90. data/lib/autosde_openapi_client/api/storage_host_api.rb +2 -2
  91. data/lib/autosde_openapi_client/api/storage_host_volume_mapping_api.rb +2 -2
  92. data/lib/autosde_openapi_client/api/storage_resource_api.rb +2 -2
  93. data/lib/autosde_openapi_client/api/storage_system_api.rb +2 -2
  94. data/lib/autosde_openapi_client/api/system_type_api.rb +2 -2
  95. data/lib/autosde_openapi_client/api/volume_api.rb +2 -2
  96. data/lib/autosde_openapi_client/api/volume_safe_delete_api.rb +2 -2
  97. data/lib/autosde_openapi_client/api_client.rb +6 -5
  98. data/lib/autosde_openapi_client/api_error.rb +2 -2
  99. data/lib/autosde_openapi_client/configuration.rb +7 -5
  100. data/lib/autosde_openapi_client/models/abstract_capability.rb +14 -6
  101. data/lib/autosde_openapi_client/models/account.rb +14 -6
  102. data/lib/autosde_openapi_client/models/account_post_request.rb +14 -6
  103. data/lib/autosde_openapi_client/models/account_post_response.rb +14 -6
  104. data/lib/autosde_openapi_client/models/address.rb +14 -6
  105. data/lib/autosde_openapi_client/models/address_create.rb +14 -6
  106. data/lib/autosde_openapi_client/models/auth_response.rb +14 -6
  107. data/lib/autosde_openapi_client/models/authentication.rb +14 -6
  108. data/lib/autosde_openapi_client/models/auto_sde_project.rb +14 -6
  109. data/lib/autosde_openapi_client/models/auto_sde_role.rb +14 -6
  110. data/lib/autosde_openapi_client/models/capability_translation.rb +14 -6
  111. data/lib/autosde_openapi_client/models/capability_translation_create.rb +14 -6
  112. data/lib/autosde_openapi_client/models/host.rb +14 -6
  113. data/lib/autosde_openapi_client/models/host_create.rb +14 -6
  114. data/lib/autosde_openapi_client/models/host_volume_connection.rb +14 -6
  115. data/lib/autosde_openapi_client/models/host_volume_connection_create.rb +14 -6
  116. data/lib/autosde_openapi_client/models/job.rb +14 -6
  117. data/lib/autosde_openapi_client/models/job_create.rb +14 -6
  118. data/lib/autosde_openapi_client/models/native_capability.rb +14 -6
  119. data/lib/autosde_openapi_client/models/profile.rb +14 -6
  120. data/lib/autosde_openapi_client/models/provisioning_strategy.rb +14 -6
  121. data/lib/autosde_openapi_client/models/service.rb +14 -6
  122. data/lib/autosde_openapi_client/models/service_abstract_capability_value.rb +14 -6
  123. data/lib/autosde_openapi_client/models/service_create.rb +14 -6
  124. data/lib/autosde_openapi_client/models/service_resource_attachment.rb +14 -6
  125. data/lib/autosde_openapi_client/models/snapshot.rb +14 -6
  126. data/lib/autosde_openapi_client/models/snapshot_create.rb +14 -6
  127. data/lib/autosde_openapi_client/models/storage_host.rb +14 -6
  128. data/lib/autosde_openapi_client/models/storage_host_create.rb +14 -6
  129. data/lib/autosde_openapi_client/models/storage_host_response.rb +14 -6
  130. data/lib/autosde_openapi_client/models/storage_host_update.rb +14 -6
  131. data/lib/autosde_openapi_client/models/storage_host_volume_mapping.rb +14 -6
  132. data/lib/autosde_openapi_client/models/storage_host_volume_mapping_create.rb +14 -6
  133. data/lib/autosde_openapi_client/models/storage_resource.rb +14 -6
  134. data/lib/autosde_openapi_client/models/storage_resource_create.rb +14 -6
  135. data/lib/autosde_openapi_client/models/storage_resource_response.rb +14 -6
  136. data/lib/autosde_openapi_client/models/storage_system.rb +14 -6
  137. data/lib/autosde_openapi_client/models/storage_system_create.rb +14 -6
  138. data/lib/autosde_openapi_client/models/system_type.rb +14 -6
  139. data/lib/autosde_openapi_client/models/system_type_create.rb +14 -6
  140. data/lib/autosde_openapi_client/models/volume.rb +14 -6
  141. data/lib/autosde_openapi_client/models/volume_create.rb +14 -6
  142. data/lib/autosde_openapi_client/models/volume_response.rb +14 -6
  143. data/lib/autosde_openapi_client/models/volume_safe_delete.rb +14 -6
  144. data/lib/autosde_openapi_client/models/volume_safe_delete_create.rb +14 -6
  145. data/lib/autosde_openapi_client/models/volume_update.rb +14 -6
  146. data/lib/autosde_openapi_client/version.rb +4 -4
  147. data/spec/api/abstract_capability_api_spec.rb +1 -1
  148. data/spec/api/account_api_spec.rb +1 -1
  149. data/spec/api/address_api_spec.rb +1 -1
  150. data/spec/api/authentication_api_spec.rb +1 -1
  151. data/spec/api/auto_sde_project_api_spec.rb +1 -1
  152. data/spec/api/auto_sde_role_api_spec.rb +1 -1
  153. data/spec/api/capability_translation_api_spec.rb +1 -1
  154. data/spec/api/host_api_spec.rb +1 -1
  155. data/spec/api/host_volume_connection_api_spec.rb +1 -1
  156. data/spec/api/job_api_spec.rb +1 -1
  157. data/spec/api/native_capability_api_spec.rb +1 -1
  158. data/spec/api/profile_api_spec.rb +1 -1
  159. data/spec/api/provisioning_strategy_api_spec.rb +1 -1
  160. data/spec/api/service_api_spec.rb +1 -1
  161. data/spec/api/service_resource_attachment_api_spec.rb +1 -1
  162. data/spec/api/snapshot_api_spec.rb +1 -1
  163. data/spec/api/storage_host_api_spec.rb +1 -1
  164. data/spec/api/storage_host_volume_mapping_api_spec.rb +1 -1
  165. data/spec/api/storage_resource_api_spec.rb +1 -1
  166. data/spec/api/storage_system_api_spec.rb +1 -1
  167. data/spec/api/system_type_api_spec.rb +1 -1
  168. data/spec/api/volume_api_spec.rb +1 -1
  169. data/spec/api/volume_safe_delete_api_spec.rb +1 -1
  170. data/spec/api_client_spec.rb +30 -30
  171. data/spec/configuration_spec.rb +4 -4
  172. data/spec/models/abstract_capability_spec.rb +4 -11
  173. data/spec/models/account_post_request_spec.rb +4 -11
  174. data/spec/models/account_post_response_spec.rb +4 -11
  175. data/spec/models/account_spec.rb +4 -11
  176. data/spec/models/address_create_spec.rb +6 -13
  177. data/spec/models/address_spec.rb +6 -13
  178. data/spec/models/auth_response_spec.rb +4 -11
  179. data/spec/models/authentication_spec.rb +4 -11
  180. data/spec/models/auto_sde_project_spec.rb +4 -11
  181. data/spec/models/auto_sde_role_spec.rb +4 -11
  182. data/spec/models/capability_translation_create_spec.rb +4 -11
  183. data/spec/models/capability_translation_spec.rb +4 -11
  184. data/spec/models/host_create_spec.rb +7 -14
  185. data/spec/models/host_spec.rb +6 -13
  186. data/spec/models/host_volume_connection_create_spec.rb +5 -12
  187. data/spec/models/host_volume_connection_spec.rb +5 -12
  188. data/spec/models/job_create_spec.rb +4 -11
  189. data/spec/models/job_spec.rb +4 -11
  190. data/spec/models/native_capability_spec.rb +4 -11
  191. data/spec/models/profile_spec.rb +5 -12
  192. data/spec/models/provisioning_strategy_spec.rb +5 -12
  193. data/spec/models/service_abstract_capability_value_spec.rb +4 -11
  194. data/spec/models/service_create_spec.rb +5 -12
  195. data/spec/models/service_resource_attachment_spec.rb +4 -11
  196. data/spec/models/service_spec.rb +5 -12
  197. data/spec/models/snapshot_create_spec.rb +5 -12
  198. data/spec/models/snapshot_spec.rb +5 -12
  199. data/spec/models/storage_host_create_spec.rb +6 -13
  200. data/spec/models/storage_host_response_spec.rb +5 -12
  201. data/spec/models/storage_host_spec.rb +5 -12
  202. data/spec/models/storage_host_update_spec.rb +6 -13
  203. data/spec/models/storage_host_volume_mapping_create_spec.rb +5 -12
  204. data/spec/models/storage_host_volume_mapping_spec.rb +5 -12
  205. data/spec/models/storage_resource_create_spec.rb +6 -13
  206. data/spec/models/storage_resource_response_spec.rb +6 -13
  207. data/spec/models/storage_resource_spec.rb +6 -13
  208. data/spec/models/storage_system_create_spec.rb +7 -14
  209. data/spec/models/storage_system_spec.rb +6 -13
  210. data/spec/models/system_type_create_spec.rb +6 -13
  211. data/spec/models/system_type_spec.rb +6 -13
  212. data/spec/models/volume_create_spec.rb +5 -12
  213. data/spec/models/volume_response_spec.rb +5 -12
  214. data/spec/models/volume_safe_delete_create_spec.rb +4 -11
  215. data/spec/models/volume_safe_delete_spec.rb +4 -11
  216. data/spec/models/volume_spec.rb +5 -12
  217. data/spec/models/volume_update_spec.rb +4 -11
  218. data/spec/spec_helper.rb +1 -1
  219. metadata +55 -55
@@ -1,25 +1,26 @@
1
- # OpenapiClient::SystemType
1
+ # AutosdeOpenapiClient::SystemType
2
2
 
3
3
  ## Properties
4
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]
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
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'OpenapiClient'
16
+ require 'autosde_openapi_client'
17
17
 
18
- instance = OpenapiClient::SystemType.new(component_state: null,
19
- name: null,
20
- short_version: null,
21
- uuid: null,
22
- version: null)
18
+ instance = AutosdeOpenapiClient::SystemType.new(
19
+ component_state: null,
20
+ name: null,
21
+ short_version: null,
22
+ uuid: null,
23
+ version: null
24
+ )
23
25
  ```
24
26
 
25
-
@@ -1,40 +1,58 @@
1
- # OpenapiClient::SystemTypeApi
1
+ # AutosdeOpenapiClient::SystemTypeApi
2
2
 
3
3
  All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
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
-
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/ | |
12
11
 
13
12
 
14
13
  ## system_types_get
15
14
 
16
- > Array<SystemType> system_types_get
15
+ > <Array<SystemType>> system_types_get
17
16
 
18
17
 
19
18
 
20
- ### Example
19
+ ### Examples
21
20
 
22
21
  ```ruby
23
- # load the gem
22
+ require 'time'
24
23
  require 'autosde_openapi_client'
25
24
  # setup authorization
26
- OpenapiClient.configure do |config|
25
+ AutosdeOpenapiClient.configure do |config|
27
26
  # Configure Bearer authorization: bearerAuth
28
27
  config.access_token = 'YOUR_BEARER_TOKEN'
29
28
  end
30
29
 
31
- api_instance = OpenapiClient::SystemTypeApi.new
30
+ api_instance = AutosdeOpenapiClient::SystemTypeApi.new
32
31
 
33
32
  begin
33
+
34
34
  result = api_instance.system_types_get
35
35
  p result
36
- rescue OpenapiClient::ApiError => e
37
- puts "Exception when calling SystemTypeApi->system_types_get: #{e}"
36
+ rescue AutosdeOpenapiClient::ApiError => e
37
+ puts "Error when calling SystemTypeApi->system_types_get: #{e}"
38
+ end
39
+ ```
40
+
41
+ #### Using the system_types_get_with_http_info variant
42
+
43
+ This returns an Array which contains the response data, status code and headers.
44
+
45
+ > <Array(<Array<SystemType>>, Integer, Hash)> system_types_get_with_http_info
46
+
47
+ ```ruby
48
+ begin
49
+
50
+ data, status_code, headers = api_instance.system_types_get_with_http_info
51
+ p status_code # => 2xx
52
+ p headers # => { ... }
53
+ p data # => <Array<SystemType>>
54
+ rescue AutosdeOpenapiClient::ApiError => e
55
+ puts "Error when calling SystemTypeApi->system_types_get_with_http_info: #{e}"
38
56
  end
39
57
  ```
40
58
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
58
76
 
59
77
  ## system_types_pk_delete
60
78
 
61
- > Array&lt;SystemType&gt; system_types_pk_delete(pk)
79
+ > <Array<SystemType>> system_types_pk_delete(pk)
62
80
 
63
81
 
64
82
 
65
- ### Example
83
+ ### Examples
66
84
 
67
85
  ```ruby
68
- # load the gem
86
+ require 'time'
69
87
  require 'autosde_openapi_client'
70
88
  # setup authorization
71
- OpenapiClient.configure do |config|
89
+ AutosdeOpenapiClient.configure do |config|
72
90
  # Configure Bearer authorization: bearerAuth
73
91
  config.access_token = 'YOUR_BEARER_TOKEN'
74
92
  end
75
93
 
76
- api_instance = OpenapiClient::SystemTypeApi.new
94
+ api_instance = AutosdeOpenapiClient::SystemTypeApi.new
77
95
  pk = 56 # Integer |
78
96
 
79
97
  begin
98
+
80
99
  result = api_instance.system_types_pk_delete(pk)
81
100
  p result
82
- rescue OpenapiClient::ApiError => e
83
- puts "Exception when calling SystemTypeApi->system_types_pk_delete: #{e}"
101
+ rescue AutosdeOpenapiClient::ApiError => e
102
+ puts "Error when calling SystemTypeApi->system_types_pk_delete: #{e}"
84
103
  end
85
104
  ```
86
105
 
87
- ### Parameters
106
+ #### Using the system_types_pk_delete_with_http_info variant
107
+
108
+ This returns an Array which contains the response data, status code and headers.
109
+
110
+ > <Array(<Array<SystemType>>, Integer, Hash)> system_types_pk_delete_with_http_info(pk)
88
111
 
112
+ ```ruby
113
+ begin
114
+
115
+ data, status_code, headers = api_instance.system_types_pk_delete_with_http_info(pk)
116
+ p status_code # => 2xx
117
+ p headers # => { ... }
118
+ p data # => <Array<SystemType>>
119
+ rescue AutosdeOpenapiClient::ApiError => e
120
+ puts "Error when calling SystemTypeApi->system_types_pk_delete_with_http_info: #{e}"
121
+ end
122
+ ```
123
+
124
+ ### Parameters
89
125
 
90
- Name | Type | Description | Notes
91
- ------------- | ------------- | ------------- | -------------
92
- **pk** | **Integer**| |
126
+ | Name | Type | Description | Notes |
127
+ | ---- | ---- | ----------- | ----- |
128
+ | **pk** | **Integer** | | |
93
129
 
94
130
  ### Return type
95
131
 
@@ -107,38 +143,56 @@ Name | Type | Description | Notes
107
143
 
108
144
  ## system_types_pk_get
109
145
 
110
- > Array&lt;SystemType&gt; system_types_pk_get(pk)
146
+ > <Array<SystemType>> system_types_pk_get(pk)
111
147
 
112
148
 
113
149
 
114
- ### Example
150
+ ### Examples
115
151
 
116
152
  ```ruby
117
- # load the gem
153
+ require 'time'
118
154
  require 'autosde_openapi_client'
119
155
  # setup authorization
120
- OpenapiClient.configure do |config|
156
+ AutosdeOpenapiClient.configure do |config|
121
157
  # Configure Bearer authorization: bearerAuth
122
158
  config.access_token = 'YOUR_BEARER_TOKEN'
123
159
  end
124
160
 
125
- api_instance = OpenapiClient::SystemTypeApi.new
161
+ api_instance = AutosdeOpenapiClient::SystemTypeApi.new
126
162
  pk = 56 # Integer |
127
163
 
128
164
  begin
165
+
129
166
  result = api_instance.system_types_pk_get(pk)
130
167
  p result
131
- rescue OpenapiClient::ApiError => e
132
- puts "Exception when calling SystemTypeApi->system_types_pk_get: #{e}"
168
+ rescue AutosdeOpenapiClient::ApiError => e
169
+ puts "Error when calling SystemTypeApi->system_types_pk_get: #{e}"
133
170
  end
134
171
  ```
135
172
 
136
- ### Parameters
173
+ #### Using the system_types_pk_get_with_http_info variant
174
+
175
+ This returns an Array which contains the response data, status code and headers.
176
+
177
+ > <Array(<Array<SystemType>>, Integer, Hash)> system_types_pk_get_with_http_info(pk)
137
178
 
179
+ ```ruby
180
+ begin
181
+
182
+ data, status_code, headers = api_instance.system_types_pk_get_with_http_info(pk)
183
+ p status_code # => 2xx
184
+ p headers # => { ... }
185
+ p data # => <Array<SystemType>>
186
+ rescue AutosdeOpenapiClient::ApiError => e
187
+ puts "Error when calling SystemTypeApi->system_types_pk_get_with_http_info: #{e}"
188
+ end
189
+ ```
190
+
191
+ ### Parameters
138
192
 
139
- Name | Type | Description | Notes
140
- ------------- | ------------- | ------------- | -------------
141
- **pk** | **Integer**| |
193
+ | Name | Type | Description | Notes |
194
+ | ---- | ---- | ----------- | ----- |
195
+ | **pk** | **Integer** | | |
142
196
 
143
197
  ### Return type
144
198
 
@@ -156,38 +210,56 @@ Name | Type | Description | Notes
156
210
 
157
211
  ## system_types_post
158
212
 
159
- > SystemType system_types_post(system_type_create)
213
+ > <SystemType> system_types_post(system_type_create)
160
214
 
161
215
 
162
216
 
163
- ### Example
217
+ ### Examples
164
218
 
165
219
  ```ruby
166
- # load the gem
220
+ require 'time'
167
221
  require 'autosde_openapi_client'
168
222
  # setup authorization
169
- OpenapiClient.configure do |config|
223
+ AutosdeOpenapiClient.configure do |config|
170
224
  # Configure Bearer authorization: bearerAuth
171
225
  config.access_token = 'YOUR_BEARER_TOKEN'
172
226
  end
173
227
 
174
- api_instance = OpenapiClient::SystemTypeApi.new
175
- system_type_create = OpenapiClient::SystemTypeCreate.new # SystemTypeCreate |
228
+ api_instance = AutosdeOpenapiClient::SystemTypeApi.new
229
+ system_type_create = AutosdeOpenapiClient::SystemTypeCreate.new # SystemTypeCreate |
176
230
 
177
231
  begin
232
+
178
233
  result = api_instance.system_types_post(system_type_create)
179
234
  p result
180
- rescue OpenapiClient::ApiError => e
181
- puts "Exception when calling SystemTypeApi->system_types_post: #{e}"
235
+ rescue AutosdeOpenapiClient::ApiError => e
236
+ puts "Error when calling SystemTypeApi->system_types_post: #{e}"
182
237
  end
183
238
  ```
184
239
 
185
- ### Parameters
240
+ #### Using the system_types_post_with_http_info variant
241
+
242
+ This returns an Array which contains the response data, status code and headers.
243
+
244
+ > <Array(<SystemType>, Integer, Hash)> system_types_post_with_http_info(system_type_create)
186
245
 
246
+ ```ruby
247
+ begin
248
+
249
+ data, status_code, headers = api_instance.system_types_post_with_http_info(system_type_create)
250
+ p status_code # => 2xx
251
+ p headers # => { ... }
252
+ p data # => <SystemType>
253
+ rescue AutosdeOpenapiClient::ApiError => e
254
+ puts "Error when calling SystemTypeApi->system_types_post_with_http_info: #{e}"
255
+ end
256
+ ```
257
+
258
+ ### Parameters
187
259
 
188
- Name | Type | Description | Notes
189
- ------------- | ------------- | ------------- | -------------
190
- **system_type_create** | [**SystemTypeCreate**](SystemTypeCreate.md)| |
260
+ | Name | Type | Description | Notes |
261
+ | ---- | ---- | ----------- | ----- |
262
+ | **system_type_create** | [**SystemTypeCreate**](SystemTypeCreate.md) | | |
191
263
 
192
264
  ### Return type
193
265
 
@@ -1,27 +1,28 @@
1
- # OpenapiClient::SystemTypeCreate
1
+ # AutosdeOpenapiClient::SystemTypeCreate
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **component_state** | **String** | component_state | [optional]
8
- **name** | **String** | name | [optional] [default to &#39;xiv&#39;]
9
- **short_version** | **String** | short_version | [optional]
10
- **super_type** | **String** | super_type | [optional] [default to &#39;null&#39;]
11
- **uuid** | **String** | uuid | [optional]
12
- **version** | **String** | SystemType version | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **component_state** | **String** | component_state | [optional] |
8
+ | **name** | **String** | name | [optional][default to &#39;xiv&#39;] |
9
+ | **short_version** | **String** | short_version | [optional] |
10
+ | **super_type** | **String** | super_type | [optional][default to &#39;null&#39;] |
11
+ | **uuid** | **String** | uuid | [optional] |
12
+ | **version** | **String** | SystemType version | [optional] |
13
13
 
14
- ## Code Sample
14
+ ## Example
15
15
 
16
16
  ```ruby
17
- require 'OpenapiClient'
17
+ require 'autosde_openapi_client'
18
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)
19
+ instance = AutosdeOpenapiClient::SystemTypeCreate.new(
20
+ component_state: null,
21
+ name: null,
22
+ short_version: null,
23
+ super_type: null,
24
+ uuid: null,
25
+ version: null
26
+ )
25
27
  ```
26
28
 
27
-
@@ -1,33 +1,34 @@
1
- # OpenapiClient::Volume
1
+ # AutosdeOpenapiClient::Volume
2
2
 
3
3
  ## Properties
4
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
- **unmapped_since** | **Time** | unmapped_since | [optional]
15
- **uuid** | **String** | uuid | [optional]
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
+ | **unmapped_since** | **Time** | unmapped_since | [optional] |
15
+ | **uuid** | **String** | uuid | [optional] |
16
16
 
17
- ## Code Sample
17
+ ## Example
18
18
 
19
19
  ```ruby
20
- require 'OpenapiClient'
20
+ require 'autosde_openapi_client'
21
21
 
22
- instance = OpenapiClient::Volume.new(compliant: null,
23
- component_state: null,
24
- historical_service: null,
25
- name: null,
26
- service: null,
27
- size: null,
28
- storage_resource: null,
29
- unmapped_since: null,
30
- uuid: null)
22
+ instance = AutosdeOpenapiClient::Volume.new(
23
+ compliant: null,
24
+ component_state: null,
25
+ historical_service: null,
26
+ name: null,
27
+ service: null,
28
+ size: null,
29
+ storage_resource: null,
30
+ unmapped_since: null,
31
+ uuid: null
32
+ )
31
33
  ```
32
34
 
33
-
@@ -1,41 +1,59 @@
1
- # OpenapiClient::VolumeApi
1
+ # AutosdeOpenapiClient::VolumeApi
2
2
 
3
3
  All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
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
-
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/ | |
13
12
 
14
13
 
15
14
  ## volumes_get
16
15
 
17
- > Array&lt;VolumeResponse&gt; volumes_get
16
+ > <Array<VolumeResponse>> volumes_get
18
17
 
19
18
 
20
19
 
21
- ### Example
20
+ ### Examples
22
21
 
23
22
  ```ruby
24
- # load the gem
23
+ require 'time'
25
24
  require 'autosde_openapi_client'
26
25
  # setup authorization
27
- OpenapiClient.configure do |config|
26
+ AutosdeOpenapiClient.configure do |config|
28
27
  # Configure Bearer authorization: bearerAuth
29
28
  config.access_token = 'YOUR_BEARER_TOKEN'
30
29
  end
31
30
 
32
- api_instance = OpenapiClient::VolumeApi.new
31
+ api_instance = AutosdeOpenapiClient::VolumeApi.new
33
32
 
34
33
  begin
34
+
35
35
  result = api_instance.volumes_get
36
36
  p result
37
- rescue OpenapiClient::ApiError => e
38
- puts "Exception when calling VolumeApi->volumes_get: #{e}"
37
+ rescue AutosdeOpenapiClient::ApiError => e
38
+ puts "Error when calling VolumeApi->volumes_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the volumes_get_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<Array<VolumeResponse>>, Integer, Hash)> volumes_get_with_http_info
47
+
48
+ ```ruby
49
+ begin
50
+
51
+ data, status_code, headers = api_instance.volumes_get_with_http_info
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <Array<VolumeResponse>>
55
+ rescue AutosdeOpenapiClient::ApiError => e
56
+ puts "Error when calling VolumeApi->volumes_get_with_http_info: #{e}"
39
57
  end
40
58
  ```
41
59
 
@@ -59,38 +77,56 @@ This endpoint does not need any parameter.
59
77
 
60
78
  ## volumes_pk_delete
61
79
 
62
- > Array&lt;Volume&gt; volumes_pk_delete(pk)
80
+ > <Array<Volume>> volumes_pk_delete(pk)
63
81
 
64
82
 
65
83
 
66
- ### Example
84
+ ### Examples
67
85
 
68
86
  ```ruby
69
- # load the gem
87
+ require 'time'
70
88
  require 'autosde_openapi_client'
71
89
  # setup authorization
72
- OpenapiClient.configure do |config|
90
+ AutosdeOpenapiClient.configure do |config|
73
91
  # Configure Bearer authorization: bearerAuth
74
92
  config.access_token = 'YOUR_BEARER_TOKEN'
75
93
  end
76
94
 
77
- api_instance = OpenapiClient::VolumeApi.new
95
+ api_instance = AutosdeOpenapiClient::VolumeApi.new
78
96
  pk = 56 # Integer |
79
97
 
80
98
  begin
99
+
81
100
  result = api_instance.volumes_pk_delete(pk)
82
101
  p result
83
- rescue OpenapiClient::ApiError => e
84
- puts "Exception when calling VolumeApi->volumes_pk_delete: #{e}"
102
+ rescue AutosdeOpenapiClient::ApiError => e
103
+ puts "Error when calling VolumeApi->volumes_pk_delete: #{e}"
85
104
  end
86
105
  ```
87
106
 
88
- ### Parameters
107
+ #### Using the volumes_pk_delete_with_http_info variant
89
108
 
109
+ This returns an Array which contains the response data, status code and headers.
90
110
 
91
- Name | Type | Description | Notes
92
- ------------- | ------------- | ------------- | -------------
93
- **pk** | **Integer**| |
111
+ > <Array(<Array<Volume>>, Integer, Hash)> volumes_pk_delete_with_http_info(pk)
112
+
113
+ ```ruby
114
+ begin
115
+
116
+ data, status_code, headers = api_instance.volumes_pk_delete_with_http_info(pk)
117
+ p status_code # => 2xx
118
+ p headers # => { ... }
119
+ p data # => <Array<Volume>>
120
+ rescue AutosdeOpenapiClient::ApiError => e
121
+ puts "Error when calling VolumeApi->volumes_pk_delete_with_http_info: #{e}"
122
+ end
123
+ ```
124
+
125
+ ### Parameters
126
+
127
+ | Name | Type | Description | Notes |
128
+ | ---- | ---- | ----------- | ----- |
129
+ | **pk** | **Integer** | | |
94
130
 
95
131
  ### Return type
96
132
 
@@ -108,38 +144,56 @@ Name | Type | Description | Notes
108
144
 
109
145
  ## volumes_pk_get
110
146
 
111
- > Array&lt;VolumeResponse&gt; volumes_pk_get(pk)
147
+ > <Array<VolumeResponse>> volumes_pk_get(pk)
112
148
 
113
149
 
114
150
 
115
- ### Example
151
+ ### Examples
116
152
 
117
153
  ```ruby
118
- # load the gem
154
+ require 'time'
119
155
  require 'autosde_openapi_client'
120
156
  # setup authorization
121
- OpenapiClient.configure do |config|
157
+ AutosdeOpenapiClient.configure do |config|
122
158
  # Configure Bearer authorization: bearerAuth
123
159
  config.access_token = 'YOUR_BEARER_TOKEN'
124
160
  end
125
161
 
126
- api_instance = OpenapiClient::VolumeApi.new
162
+ api_instance = AutosdeOpenapiClient::VolumeApi.new
127
163
  pk = 56 # Integer |
128
164
 
129
165
  begin
166
+
130
167
  result = api_instance.volumes_pk_get(pk)
131
168
  p result
132
- rescue OpenapiClient::ApiError => e
133
- puts "Exception when calling VolumeApi->volumes_pk_get: #{e}"
169
+ rescue AutosdeOpenapiClient::ApiError => e
170
+ puts "Error when calling VolumeApi->volumes_pk_get: #{e}"
134
171
  end
135
172
  ```
136
173
 
137
- ### Parameters
174
+ #### Using the volumes_pk_get_with_http_info variant
138
175
 
176
+ This returns an Array which contains the response data, status code and headers.
139
177
 
140
- Name | Type | Description | Notes
141
- ------------- | ------------- | ------------- | -------------
142
- **pk** | **Integer**| |
178
+ > <Array(<Array<VolumeResponse>>, Integer, Hash)> volumes_pk_get_with_http_info(pk)
179
+
180
+ ```ruby
181
+ begin
182
+
183
+ data, status_code, headers = api_instance.volumes_pk_get_with_http_info(pk)
184
+ p status_code # => 2xx
185
+ p headers # => { ... }
186
+ p data # => <Array<VolumeResponse>>
187
+ rescue AutosdeOpenapiClient::ApiError => e
188
+ puts "Error when calling VolumeApi->volumes_pk_get_with_http_info: #{e}"
189
+ end
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ | Name | Type | Description | Notes |
195
+ | ---- | ---- | ----------- | ----- |
196
+ | **pk** | **Integer** | | |
143
197
 
144
198
  ### Return type
145
199
 
@@ -157,40 +211,58 @@ Name | Type | Description | Notes
157
211
 
158
212
  ## volumes_pk_put
159
213
 
160
- > VolumeResponse volumes_pk_put(pk, volume_update)
214
+ > <VolumeResponse> volumes_pk_put(pk, volume_update)
161
215
 
162
216
 
163
217
 
164
- ### Example
218
+ ### Examples
165
219
 
166
220
  ```ruby
167
- # load the gem
221
+ require 'time'
168
222
  require 'autosde_openapi_client'
169
223
  # setup authorization
170
- OpenapiClient.configure do |config|
224
+ AutosdeOpenapiClient.configure do |config|
171
225
  # Configure Bearer authorization: bearerAuth
172
226
  config.access_token = 'YOUR_BEARER_TOKEN'
173
227
  end
174
228
 
175
- api_instance = OpenapiClient::VolumeApi.new
229
+ api_instance = AutosdeOpenapiClient::VolumeApi.new
176
230
  pk = 56 # Integer |
177
- volume_update = OpenapiClient::VolumeUpdate.new # VolumeUpdate |
231
+ volume_update = AutosdeOpenapiClient::VolumeUpdate.new # VolumeUpdate |
178
232
 
179
233
  begin
234
+
180
235
  result = api_instance.volumes_pk_put(pk, volume_update)
181
236
  p result
182
- rescue OpenapiClient::ApiError => e
183
- puts "Exception when calling VolumeApi->volumes_pk_put: #{e}"
237
+ rescue AutosdeOpenapiClient::ApiError => e
238
+ puts "Error when calling VolumeApi->volumes_pk_put: #{e}"
184
239
  end
185
240
  ```
186
241
 
187
- ### Parameters
242
+ #### Using the volumes_pk_put_with_http_info variant
243
+
244
+ This returns an Array which contains the response data, status code and headers.
245
+
246
+ > <Array(<VolumeResponse>, Integer, Hash)> volumes_pk_put_with_http_info(pk, volume_update)
247
+
248
+ ```ruby
249
+ begin
250
+
251
+ data, status_code, headers = api_instance.volumes_pk_put_with_http_info(pk, volume_update)
252
+ p status_code # => 2xx
253
+ p headers # => { ... }
254
+ p data # => <VolumeResponse>
255
+ rescue AutosdeOpenapiClient::ApiError => e
256
+ puts "Error when calling VolumeApi->volumes_pk_put_with_http_info: #{e}"
257
+ end
258
+ ```
188
259
 
260
+ ### Parameters
189
261
 
190
- Name | Type | Description | Notes
191
- ------------- | ------------- | ------------- | -------------
192
- **pk** | **Integer**| |
193
- **volume_update** | [**VolumeUpdate**](VolumeUpdate.md)| |
262
+ | Name | Type | Description | Notes |
263
+ | ---- | ---- | ----------- | ----- |
264
+ | **pk** | **Integer** | | |
265
+ | **volume_update** | [**VolumeUpdate**](VolumeUpdate.md) | | |
194
266
 
195
267
  ### Return type
196
268
 
@@ -208,38 +280,56 @@ Name | Type | Description | Notes
208
280
 
209
281
  ## volumes_post
210
282
 
211
- > VolumeResponse volumes_post(volume_create)
283
+ > <VolumeResponse> volumes_post(volume_create)
212
284
 
213
285
 
214
286
 
215
- ### Example
287
+ ### Examples
216
288
 
217
289
  ```ruby
218
- # load the gem
290
+ require 'time'
219
291
  require 'autosde_openapi_client'
220
292
  # setup authorization
221
- OpenapiClient.configure do |config|
293
+ AutosdeOpenapiClient.configure do |config|
222
294
  # Configure Bearer authorization: bearerAuth
223
295
  config.access_token = 'YOUR_BEARER_TOKEN'
224
296
  end
225
297
 
226
- api_instance = OpenapiClient::VolumeApi.new
227
- volume_create = OpenapiClient::VolumeCreate.new # VolumeCreate |
298
+ api_instance = AutosdeOpenapiClient::VolumeApi.new
299
+ volume_create = AutosdeOpenapiClient::VolumeCreate.new # VolumeCreate |
228
300
 
229
301
  begin
302
+
230
303
  result = api_instance.volumes_post(volume_create)
231
304
  p result
232
- rescue OpenapiClient::ApiError => e
233
- puts "Exception when calling VolumeApi->volumes_post: #{e}"
305
+ rescue AutosdeOpenapiClient::ApiError => e
306
+ puts "Error when calling VolumeApi->volumes_post: #{e}"
234
307
  end
235
308
  ```
236
309
 
237
- ### Parameters
310
+ #### Using the volumes_post_with_http_info variant
238
311
 
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<VolumeResponse>, Integer, Hash)> volumes_post_with_http_info(volume_create)
315
+
316
+ ```ruby
317
+ begin
318
+
319
+ data, status_code, headers = api_instance.volumes_post_with_http_info(volume_create)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <VolumeResponse>
323
+ rescue AutosdeOpenapiClient::ApiError => e
324
+ puts "Error when calling VolumeApi->volumes_post_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
239
329
 
240
- Name | Type | Description | Notes
241
- ------------- | ------------- | ------------- | -------------
242
- **volume_create** | [**VolumeCreate**](VolumeCreate.md)| |
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **volume_create** | [**VolumeCreate**](VolumeCreate.md) | | |
243
333
 
244
334
  ### Return type
245
335