eilam_test 1.1.12 → 1.1.13

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.
data/docs/UserApi.md ADDED
@@ -0,0 +1,346 @@
1
+ # EilamTest::UserApi
2
+
3
+ All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**autosde_users_get**](UserApi.md#autosde_users_get) | **GET** /autosde-users | |
8
+ | [**autosde_users_pk_delete**](UserApi.md#autosde_users_pk_delete) | **DELETE** /autosde-users/{pk} | |
9
+ | [**autosde_users_pk_get**](UserApi.md#autosde_users_pk_get) | **GET** /autosde-users/{pk} | |
10
+ | [**autosde_users_pk_put**](UserApi.md#autosde_users_pk_put) | **PUT** /autosde-users/{pk} | |
11
+ | [**autosde_users_post**](UserApi.md#autosde_users_post) | **POST** /autosde-users | |
12
+
13
+
14
+ ## autosde_users_get
15
+
16
+ > <Array<UserCreate>> autosde_users_get
17
+
18
+
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'eilam_test'
25
+ # setup authorization
26
+ EilamTest.configure do |config|
27
+ # Configure Bearer authorization: bearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+ end
30
+
31
+ api_instance = EilamTest::UserApi.new
32
+
33
+ begin
34
+
35
+ result = api_instance.autosde_users_get
36
+ p result
37
+ rescue EilamTest::ApiError => e
38
+ puts "Error when calling UserApi->autosde_users_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the autosde_users_get_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<Array<UserCreate>>, Integer, Hash)> autosde_users_get_with_http_info
47
+
48
+ ```ruby
49
+ begin
50
+
51
+ data, status_code, headers = api_instance.autosde_users_get_with_http_info
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <Array<UserCreate>>
55
+ rescue EilamTest::ApiError => e
56
+ puts "Error when calling UserApi->autosde_users_get_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ This endpoint does not need any parameter.
63
+
64
+ ### Return type
65
+
66
+ [**Array&lt;UserCreate&gt;**](UserCreate.md)
67
+
68
+ ### Authorization
69
+
70
+ [bearerAuth](../README.md#bearerAuth)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: Not defined
75
+ - **Accept**: */*
76
+
77
+
78
+ ## autosde_users_pk_delete
79
+
80
+ > <Array<User>> autosde_users_pk_delete(pk)
81
+
82
+
83
+
84
+ ### Examples
85
+
86
+ ```ruby
87
+ require 'time'
88
+ require 'eilam_test'
89
+ # setup authorization
90
+ EilamTest.configure do |config|
91
+ # Configure Bearer authorization: bearerAuth
92
+ config.access_token = 'YOUR_BEARER_TOKEN'
93
+ end
94
+
95
+ api_instance = EilamTest::UserApi.new
96
+ pk = 56 # Integer |
97
+
98
+ begin
99
+
100
+ result = api_instance.autosde_users_pk_delete(pk)
101
+ p result
102
+ rescue EilamTest::ApiError => e
103
+ puts "Error when calling UserApi->autosde_users_pk_delete: #{e}"
104
+ end
105
+ ```
106
+
107
+ #### Using the autosde_users_pk_delete_with_http_info variant
108
+
109
+ This returns an Array which contains the response data, status code and headers.
110
+
111
+ > <Array(<Array<User>>, Integer, Hash)> autosde_users_pk_delete_with_http_info(pk)
112
+
113
+ ```ruby
114
+ begin
115
+
116
+ data, status_code, headers = api_instance.autosde_users_pk_delete_with_http_info(pk)
117
+ p status_code # => 2xx
118
+ p headers # => { ... }
119
+ p data # => <Array<User>>
120
+ rescue EilamTest::ApiError => e
121
+ puts "Error when calling UserApi->autosde_users_pk_delete_with_http_info: #{e}"
122
+ end
123
+ ```
124
+
125
+ ### Parameters
126
+
127
+ | Name | Type | Description | Notes |
128
+ | ---- | ---- | ----------- | ----- |
129
+ | **pk** | **Integer** | | |
130
+
131
+ ### Return type
132
+
133
+ [**Array&lt;User&gt;**](User.md)
134
+
135
+ ### Authorization
136
+
137
+ [bearerAuth](../README.md#bearerAuth)
138
+
139
+ ### HTTP request headers
140
+
141
+ - **Content-Type**: Not defined
142
+ - **Accept**: */*
143
+
144
+
145
+ ## autosde_users_pk_get
146
+
147
+ > <Array<UserCreate>> autosde_users_pk_get(pk)
148
+
149
+
150
+
151
+ ### Examples
152
+
153
+ ```ruby
154
+ require 'time'
155
+ require 'eilam_test'
156
+ # setup authorization
157
+ EilamTest.configure do |config|
158
+ # Configure Bearer authorization: bearerAuth
159
+ config.access_token = 'YOUR_BEARER_TOKEN'
160
+ end
161
+
162
+ api_instance = EilamTest::UserApi.new
163
+ pk = 56 # Integer |
164
+
165
+ begin
166
+
167
+ result = api_instance.autosde_users_pk_get(pk)
168
+ p result
169
+ rescue EilamTest::ApiError => e
170
+ puts "Error when calling UserApi->autosde_users_pk_get: #{e}"
171
+ end
172
+ ```
173
+
174
+ #### Using the autosde_users_pk_get_with_http_info variant
175
+
176
+ This returns an Array which contains the response data, status code and headers.
177
+
178
+ > <Array(<Array<UserCreate>>, Integer, Hash)> autosde_users_pk_get_with_http_info(pk)
179
+
180
+ ```ruby
181
+ begin
182
+
183
+ data, status_code, headers = api_instance.autosde_users_pk_get_with_http_info(pk)
184
+ p status_code # => 2xx
185
+ p headers # => { ... }
186
+ p data # => <Array<UserCreate>>
187
+ rescue EilamTest::ApiError => e
188
+ puts "Error when calling UserApi->autosde_users_pk_get_with_http_info: #{e}"
189
+ end
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ | Name | Type | Description | Notes |
195
+ | ---- | ---- | ----------- | ----- |
196
+ | **pk** | **Integer** | | |
197
+
198
+ ### Return type
199
+
200
+ [**Array&lt;UserCreate&gt;**](UserCreate.md)
201
+
202
+ ### Authorization
203
+
204
+ [bearerAuth](../README.md#bearerAuth)
205
+
206
+ ### HTTP request headers
207
+
208
+ - **Content-Type**: Not defined
209
+ - **Accept**: */*
210
+
211
+
212
+ ## autosde_users_pk_put
213
+
214
+ > <UserCreate> autosde_users_pk_put(pk, user_update)
215
+
216
+
217
+
218
+ ### Examples
219
+
220
+ ```ruby
221
+ require 'time'
222
+ require 'eilam_test'
223
+ # setup authorization
224
+ EilamTest.configure do |config|
225
+ # Configure Bearer authorization: bearerAuth
226
+ config.access_token = 'YOUR_BEARER_TOKEN'
227
+ end
228
+
229
+ api_instance = EilamTest::UserApi.new
230
+ pk = 56 # Integer |
231
+ user_update = EilamTest::UserUpdate.new # UserUpdate |
232
+
233
+ begin
234
+
235
+ result = api_instance.autosde_users_pk_put(pk, user_update)
236
+ p result
237
+ rescue EilamTest::ApiError => e
238
+ puts "Error when calling UserApi->autosde_users_pk_put: #{e}"
239
+ end
240
+ ```
241
+
242
+ #### Using the autosde_users_pk_put_with_http_info variant
243
+
244
+ This returns an Array which contains the response data, status code and headers.
245
+
246
+ > <Array(<UserCreate>, Integer, Hash)> autosde_users_pk_put_with_http_info(pk, user_update)
247
+
248
+ ```ruby
249
+ begin
250
+
251
+ data, status_code, headers = api_instance.autosde_users_pk_put_with_http_info(pk, user_update)
252
+ p status_code # => 2xx
253
+ p headers # => { ... }
254
+ p data # => <UserCreate>
255
+ rescue EilamTest::ApiError => e
256
+ puts "Error when calling UserApi->autosde_users_pk_put_with_http_info: #{e}"
257
+ end
258
+ ```
259
+
260
+ ### Parameters
261
+
262
+ | Name | Type | Description | Notes |
263
+ | ---- | ---- | ----------- | ----- |
264
+ | **pk** | **Integer** | | |
265
+ | **user_update** | [**UserUpdate**](UserUpdate.md) | | |
266
+
267
+ ### Return type
268
+
269
+ [**UserCreate**](UserCreate.md)
270
+
271
+ ### Authorization
272
+
273
+ [bearerAuth](../README.md#bearerAuth)
274
+
275
+ ### HTTP request headers
276
+
277
+ - **Content-Type**: application/json
278
+ - **Accept**: */*
279
+
280
+
281
+ ## autosde_users_post
282
+
283
+ > <UserCreate> autosde_users_post(user_create)
284
+
285
+
286
+
287
+ ### Examples
288
+
289
+ ```ruby
290
+ require 'time'
291
+ require 'eilam_test'
292
+ # setup authorization
293
+ EilamTest.configure do |config|
294
+ # Configure Bearer authorization: bearerAuth
295
+ config.access_token = 'YOUR_BEARER_TOKEN'
296
+ end
297
+
298
+ api_instance = EilamTest::UserApi.new
299
+ user_create = EilamTest::UserCreate.new # UserCreate |
300
+
301
+ begin
302
+
303
+ result = api_instance.autosde_users_post(user_create)
304
+ p result
305
+ rescue EilamTest::ApiError => e
306
+ puts "Error when calling UserApi->autosde_users_post: #{e}"
307
+ end
308
+ ```
309
+
310
+ #### Using the autosde_users_post_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<UserCreate>, Integer, Hash)> autosde_users_post_with_http_info(user_create)
315
+
316
+ ```ruby
317
+ begin
318
+
319
+ data, status_code, headers = api_instance.autosde_users_post_with_http_info(user_create)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <UserCreate>
323
+ rescue EilamTest::ApiError => e
324
+ puts "Error when calling UserApi->autosde_users_post_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **user_create** | [**UserCreate**](UserCreate.md) | | |
333
+
334
+ ### Return type
335
+
336
+ [**UserCreate**](UserCreate.md)
337
+
338
+ ### Authorization
339
+
340
+ [bearerAuth](../README.md#bearerAuth)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: application/json
345
+ - **Accept**: */*
346
+
@@ -0,0 +1,38 @@
1
+ # EilamTest::UserCreate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date_joined** | **Time** | date_joined | [optional] |
8
+ | **email** | **String** | email | [optional] |
9
+ | **first_name** | **String** | first_name | [optional] |
10
+ | **is_active** | **Boolean** | is_active | [optional] |
11
+ | **is_staff** | **Boolean** | is_staff | [optional] |
12
+ | **is_superuser** | **Boolean** | is_superuser | [optional] |
13
+ | **last_login** | **Time** | last_login | [optional] |
14
+ | **last_name** | **String** | last_name | [optional] |
15
+ | **password** | **String** | password | [optional] |
16
+ | **username** | **String** | username | [optional] |
17
+ | **uuid** | **String** | uuid | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'eilam_test'
23
+
24
+ instance = EilamTest::UserCreate.new(
25
+ date_joined: null,
26
+ email: null,
27
+ first_name: null,
28
+ is_active: null,
29
+ is_staff: null,
30
+ is_superuser: null,
31
+ last_login: null,
32
+ last_name: null,
33
+ password: null,
34
+ username: null,
35
+ uuid: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,30 @@
1
+ # EilamTest::UserUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | email | [optional] |
8
+ | **first_name** | **String** | first_name | [optional] |
9
+ | **is_active** | **Boolean** | is_active | [optional] |
10
+ | **is_staff** | **Boolean** | is_staff | [optional] |
11
+ | **last_name** | **String** | last_name | [optional] |
12
+ | **password** | **String** | password | [optional] |
13
+ | **username** | **String** | username | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'eilam_test'
19
+
20
+ instance = EilamTest::UserUpdate.new(
21
+ email: null,
22
+ first_name: null,
23
+ is_active: null,
24
+ is_staff: null,
25
+ last_name: null,
26
+ password: null,
27
+ username: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,26 @@
1
+ # EilamTest::ValidateSystem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **management_ip** | **String** | management_ip | [optional] |
8
+ | **name** | **String** | name | [optional] |
9
+ | **password** | **String** | password | [optional] |
10
+ | **system_type** | **String** | system_type | [optional] |
11
+ | **user** | **String** | user | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'eilam_test'
17
+
18
+ instance = EilamTest::ValidateSystem.new(
19
+ management_ip: null,
20
+ name: null,
21
+ password: null,
22
+ system_type: null,
23
+ user: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,75 @@
1
+ # EilamTest::ValidateSystemApi
2
+
3
+ All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**validate_system_post**](ValidateSystemApi.md#validate_system_post) | **POST** /validate-system | |
8
+
9
+
10
+ ## validate_system_post
11
+
12
+ > <ValidateSystem> validate_system_post(storage_system_create)
13
+
14
+
15
+
16
+ ### Examples
17
+
18
+ ```ruby
19
+ require 'time'
20
+ require 'eilam_test'
21
+ # setup authorization
22
+ EilamTest.configure do |config|
23
+ # Configure Bearer authorization: bearerAuth
24
+ config.access_token = 'YOUR_BEARER_TOKEN'
25
+ end
26
+
27
+ api_instance = EilamTest::ValidateSystemApi.new
28
+ storage_system_create = EilamTest::StorageSystemCreate.new # StorageSystemCreate |
29
+
30
+ begin
31
+
32
+ result = api_instance.validate_system_post(storage_system_create)
33
+ p result
34
+ rescue EilamTest::ApiError => e
35
+ puts "Error when calling ValidateSystemApi->validate_system_post: #{e}"
36
+ end
37
+ ```
38
+
39
+ #### Using the validate_system_post_with_http_info variant
40
+
41
+ This returns an Array which contains the response data, status code and headers.
42
+
43
+ > <Array(<ValidateSystem>, Integer, Hash)> validate_system_post_with_http_info(storage_system_create)
44
+
45
+ ```ruby
46
+ begin
47
+
48
+ data, status_code, headers = api_instance.validate_system_post_with_http_info(storage_system_create)
49
+ p status_code # => 2xx
50
+ p headers # => { ... }
51
+ p data # => <ValidateSystem>
52
+ rescue EilamTest::ApiError => e
53
+ puts "Error when calling ValidateSystemApi->validate_system_post_with_http_info: #{e}"
54
+ end
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+ | Name | Type | Description | Notes |
60
+ | ---- | ---- | ----------- | ----- |
61
+ | **storage_system_create** | [**StorageSystemCreate**](StorageSystemCreate.md) | | |
62
+
63
+ ### Return type
64
+
65
+ [**ValidateSystem**](ValidateSystem.md)
66
+
67
+ ### Authorization
68
+
69
+ [bearerAuth](../README.md#bearerAuth)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: application/json
74
+ - **Accept**: */*
75
+