pnap_network_storage_api 1.4.0 → 2.0.1
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.
- checksums.yaml +4 -4
- data/README.md +12 -9
- data/VERSION +1 -1
- data/docs/StorageNetwork.md +2 -0
- data/docs/StorageNetworksApi.md +77 -87
- data/docs/Volume.md +2 -0
- data/lib/pnap_network_storage_api/api/storage_networks_api.rb +120 -100
- data/lib/pnap_network_storage_api/api_client.rb +26 -23
- data/lib/pnap_network_storage_api/api_error.rb +2 -1
- data/lib/pnap_network_storage_api/configuration.rb +28 -9
- data/lib/pnap_network_storage_api/models/error.rb +16 -19
- data/lib/pnap_network_storage_api/models/nfs_permissions.rb +14 -19
- data/lib/pnap_network_storage_api/models/nfs_permissions_create.rb +14 -19
- data/lib/pnap_network_storage_api/models/nfs_permissions_update.rb +14 -19
- data/lib/pnap_network_storage_api/models/permissions.rb +14 -19
- data/lib/pnap_network_storage_api/models/permissions_create.rb +14 -19
- data/lib/pnap_network_storage_api/models/permissions_update.rb +14 -19
- data/lib/pnap_network_storage_api/models/status.rb +8 -4
- data/lib/pnap_network_storage_api/models/storage_network.rb +47 -20
- data/lib/pnap_network_storage_api/models/storage_network_create.rb +42 -22
- data/lib/pnap_network_storage_api/models/storage_network_update.rb +36 -22
- data/lib/pnap_network_storage_api/models/storage_network_volume_create.rb +41 -23
- data/lib/pnap_network_storage_api/models/tag_assignment.rb +20 -19
- data/lib/pnap_network_storage_api/models/tag_assignment_request.rb +16 -19
- data/lib/pnap_network_storage_api/models/volume.rb +47 -20
- data/lib/pnap_network_storage_api/models/volume_create.rb +41 -23
- data/lib/pnap_network_storage_api/models/volume_update.rb +48 -26
- data/lib/pnap_network_storage_api/version.rb +1 -1
- data/lib/pnap_network_storage_api.rb +1 -1
- data/pnap_network_storage_api.gemspec +2 -2
- data/spec/api/storage_networks_api_spec.rb +70 -15
- data/spec/models/error_spec.rb +6 -4
- data/spec/models/nfs_permissions_create_spec.rb +9 -7
- data/spec/models/nfs_permissions_spec.rb +9 -7
- data/spec/models/nfs_permissions_update_spec.rb +9 -7
- data/spec/models/permissions_create_spec.rb +5 -3
- data/spec/models/permissions_spec.rb +5 -3
- data/spec/models/permissions_update_spec.rb +5 -3
- data/spec/models/status_spec.rb +4 -2
- data/spec/models/storage_network_create_spec.rb +14 -6
- data/spec/models/storage_network_spec.rb +19 -11
- data/spec/models/storage_network_update_spec.rb +6 -4
- data/spec/models/storage_network_volume_create_spec.rb +14 -6
- data/spec/models/tag_assignment_request_spec.rb +6 -4
- data/spec/models/tag_assignment_spec.rb +9 -7
- data/spec/models/volume_create_spec.rb +20 -6
- data/spec/models/volume_spec.rb +32 -12
- data/spec/models/volume_update_spec.rb +29 -3
- data/spec/spec_helper.rb +1 -1
- metadata +14 -18
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b49e5a5524d7fc5d7c4b2fec2d769b971e6a29cb11d9cdf83c3ba8a372f0620d
|
4
|
+
data.tar.gz: 21c59e38d735de2863e2db37422dd874fde228970c339d449ec130703b994394
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1c2bafe57423012d2ece9bfef67c5c252d50dab9f7decec194cef649ec08114a8a993e6b168336edd367b8f01e7f03a24ff29fd2b5e48594c34ee0359240dbcf
|
7
|
+
data.tar.gz: a8383b7ce3dfa98113ff543ffb971ba04a92daafe61629d9c12a5181c5dc7ff26a4005574a9d347fcf84e89e9a19eb4fdfd469f8f1b8fda5d23b166a3414c836
|
data/README.md
CHANGED
@@ -73,6 +73,8 @@ require 'pnap_network_storage_api'
|
|
73
73
|
NetworkStorageApi.configure do |config|
|
74
74
|
# Configure OAuth2 access token for authorization: OAuth2
|
75
75
|
config.access_token = 'YOUR ACCESS TOKEN'
|
76
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
77
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
76
78
|
end
|
77
79
|
|
78
80
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
@@ -122,16 +124,16 @@ All URIs are relative to *https://api.phoenixnap.com/network-storage/v1*
|
|
122
124
|
Class | Method | HTTP request | Description
|
123
125
|
------------ | ------------- | ------------- | -------------
|
124
126
|
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_get**](docs/StorageNetworksApi.md#storage_networks_get) | **GET** /storage-networks | List all storage networks.
|
125
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_delete**](docs/StorageNetworksApi.md#storage_networks_id_delete) | **DELETE** /storage-networks/{
|
126
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_get**](docs/StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{
|
127
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_patch**](docs/StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{
|
127
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_delete**](docs/StorageNetworksApi.md#storage_networks_id_delete) | **DELETE** /storage-networks/{storageId} | Delete a storage network and its volume.
|
128
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_get**](docs/StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{storageId} | Get storage network details.
|
129
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_patch**](docs/StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageId} | Update storage network details.
|
128
130
|
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_post**](docs/StorageNetworksApi.md#storage_networks_post) | **POST** /storage-networks | Create a storage network and volume.
|
129
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{
|
130
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_post**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{
|
131
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_delete**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{
|
132
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{
|
133
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_patch**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{
|
134
|
-
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_tags_put**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_tags_put) | **PUT** /storage-networks/{
|
131
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{storageId}/volumes | Display one or more volumes belonging to a storage network.
|
132
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_post**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{storageId}/volumes | Create a volume belonging to a storage network.
|
133
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_delete**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{storageId}/volumes/{volumeId} | Delete a Storage Network's Volume
|
134
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{storageId}/volumes/{volumeId} | Get a storage network's volume details.
|
135
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_patch**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{storageId}/volumes/{volumeId} | Update a storage network's volume details.
|
136
|
+
*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_tags_put**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_tags_put) | **PUT** /storage-networks/{storageId}/volumes/{volumeId}/tags | Overwrites tags assigned for the volume.
|
135
137
|
|
136
138
|
|
137
139
|
## Documentation for Models
|
@@ -158,6 +160,7 @@ Class | Method | HTTP request | Description
|
|
158
160
|
## Documentation for Authorization
|
159
161
|
|
160
162
|
|
163
|
+
Authentication schemes defined for the API:
|
161
164
|
### OAuth2
|
162
165
|
|
163
166
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
2.0.1
|
data/docs/StorageNetwork.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **network_id** | **String** | Id of network the storage belongs to. | [optional] |
|
13
13
|
| **ips** | **Array<String>** | IP of the storage network. | [optional] |
|
14
14
|
| **created_on** | **Time** | Date and time when this storage network was created. | [optional] |
|
15
|
+
| **delete_requested_on** | **Time** | Date and time of the initial request for storage network deletion. | [optional] |
|
15
16
|
| **volumes** | [**Array<Volume>**](Volume.md) | Volume for a storage network. | [optional] |
|
16
17
|
|
17
18
|
## Example
|
@@ -28,6 +29,7 @@ instance = NetworkStorageApi::StorageNetwork.new(
|
|
28
29
|
network_id: 603f3b2cfcaf050643b89a4b,
|
29
30
|
ips: ["100.64.0.1","100.64.0.2"],
|
30
31
|
created_on: 2021-03-13T20:24:32.491Z,
|
32
|
+
delete_requested_on: 2022-04-07T08:50:20.359Z,
|
31
33
|
volumes: null
|
32
34
|
)
|
33
35
|
```
|
data/docs/StorageNetworksApi.md
CHANGED
@@ -5,16 +5,16 @@ All URIs are relative to *https://api.phoenixnap.com/network-storage/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**storage_networks_get**](StorageNetworksApi.md#storage_networks_get) | **GET** /storage-networks | List all storage networks. |
|
8
|
-
| [**storage_networks_id_delete**](StorageNetworksApi.md#storage_networks_id_delete) | **DELETE** /storage-networks/{
|
9
|
-
| [**storage_networks_id_get**](StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{
|
10
|
-
| [**storage_networks_id_patch**](StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{
|
8
|
+
| [**storage_networks_id_delete**](StorageNetworksApi.md#storage_networks_id_delete) | **DELETE** /storage-networks/{storageId} | Delete a storage network and its volume. |
|
9
|
+
| [**storage_networks_id_get**](StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{storageId} | Get storage network details. |
|
10
|
+
| [**storage_networks_id_patch**](StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageId} | Update storage network details. |
|
11
11
|
| [**storage_networks_post**](StorageNetworksApi.md#storage_networks_post) | **POST** /storage-networks | Create a storage network and volume. |
|
12
|
-
| [**storage_networks_storage_network_id_volumes_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{
|
13
|
-
| [**storage_networks_storage_network_id_volumes_post**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{
|
14
|
-
| [**storage_networks_storage_network_id_volumes_volume_id_delete**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{
|
15
|
-
| [**storage_networks_storage_network_id_volumes_volume_id_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{
|
16
|
-
| [**storage_networks_storage_network_id_volumes_volume_id_patch**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{
|
17
|
-
| [**storage_networks_storage_network_id_volumes_volume_id_tags_put**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_tags_put) | **PUT** /storage-networks/{
|
12
|
+
| [**storage_networks_storage_network_id_volumes_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{storageId}/volumes | Display one or more volumes belonging to a storage network. |
|
13
|
+
| [**storage_networks_storage_network_id_volumes_post**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{storageId}/volumes | Create a volume belonging to a storage network. |
|
14
|
+
| [**storage_networks_storage_network_id_volumes_volume_id_delete**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{storageId}/volumes/{volumeId} | Delete a Storage Network's Volume |
|
15
|
+
| [**storage_networks_storage_network_id_volumes_volume_id_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{storageId}/volumes/{volumeId} | Get a storage network's volume details. |
|
16
|
+
| [**storage_networks_storage_network_id_volumes_volume_id_patch**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{storageId}/volumes/{volumeId} | Update a storage network's volume details. |
|
17
|
+
| [**storage_networks_storage_network_id_volumes_volume_id_tags_put**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_tags_put) | **PUT** /storage-networks/{storageId}/volumes/{volumeId}/tags | Overwrites tags assigned for the volume. |
|
18
18
|
|
19
19
|
|
20
20
|
## storage_networks_get
|
@@ -90,7 +90,7 @@ end
|
|
90
90
|
|
91
91
|
## storage_networks_id_delete
|
92
92
|
|
93
|
-
> storage_networks_id_delete(
|
93
|
+
> storage_networks_id_delete(storage_id)
|
94
94
|
|
95
95
|
Delete a storage network and its volume.
|
96
96
|
|
@@ -108,11 +108,11 @@ NetworkStorageApi.configure do |config|
|
|
108
108
|
end
|
109
109
|
|
110
110
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
111
|
-
|
111
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
112
112
|
|
113
113
|
begin
|
114
114
|
# Delete a storage network and its volume.
|
115
|
-
api_instance.storage_networks_id_delete(
|
115
|
+
api_instance.storage_networks_id_delete(storage_id)
|
116
116
|
rescue NetworkStorageApi::ApiError => e
|
117
117
|
puts "Error when calling StorageNetworksApi->storage_networks_id_delete: #{e}"
|
118
118
|
end
|
@@ -122,12 +122,12 @@ end
|
|
122
122
|
|
123
123
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
124
124
|
|
125
|
-
> <Array(nil, Integer, Hash)> storage_networks_id_delete_with_http_info(
|
125
|
+
> <Array(nil, Integer, Hash)> storage_networks_id_delete_with_http_info(storage_id)
|
126
126
|
|
127
127
|
```ruby
|
128
128
|
begin
|
129
129
|
# Delete a storage network and its volume.
|
130
|
-
data, status_code, headers = api_instance.storage_networks_id_delete_with_http_info(
|
130
|
+
data, status_code, headers = api_instance.storage_networks_id_delete_with_http_info(storage_id)
|
131
131
|
p status_code # => 2xx
|
132
132
|
p headers # => { ... }
|
133
133
|
p data # => nil
|
@@ -140,7 +140,7 @@ end
|
|
140
140
|
|
141
141
|
| Name | Type | Description | Notes |
|
142
142
|
| ---- | ---- | ----------- | ----- |
|
143
|
-
| **
|
143
|
+
| **storage_id** | **String** | ID of the storage. | |
|
144
144
|
|
145
145
|
### Return type
|
146
146
|
|
@@ -158,7 +158,7 @@ nil (empty response body)
|
|
158
158
|
|
159
159
|
## storage_networks_id_get
|
160
160
|
|
161
|
-
> <StorageNetwork> storage_networks_id_get(
|
161
|
+
> <StorageNetwork> storage_networks_id_get(storage_id)
|
162
162
|
|
163
163
|
Get storage network details.
|
164
164
|
|
@@ -176,11 +176,11 @@ NetworkStorageApi.configure do |config|
|
|
176
176
|
end
|
177
177
|
|
178
178
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
179
|
-
|
179
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
180
180
|
|
181
181
|
begin
|
182
182
|
# Get storage network details.
|
183
|
-
result = api_instance.storage_networks_id_get(
|
183
|
+
result = api_instance.storage_networks_id_get(storage_id)
|
184
184
|
p result
|
185
185
|
rescue NetworkStorageApi::ApiError => e
|
186
186
|
puts "Error when calling StorageNetworksApi->storage_networks_id_get: #{e}"
|
@@ -191,12 +191,12 @@ end
|
|
191
191
|
|
192
192
|
This returns an Array which contains the response data, status code and headers.
|
193
193
|
|
194
|
-
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_id_get_with_http_info(
|
194
|
+
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_id_get_with_http_info(storage_id)
|
195
195
|
|
196
196
|
```ruby
|
197
197
|
begin
|
198
198
|
# Get storage network details.
|
199
|
-
data, status_code, headers = api_instance.storage_networks_id_get_with_http_info(
|
199
|
+
data, status_code, headers = api_instance.storage_networks_id_get_with_http_info(storage_id)
|
200
200
|
p status_code # => 2xx
|
201
201
|
p headers # => { ... }
|
202
202
|
p data # => <StorageNetwork>
|
@@ -209,7 +209,7 @@ end
|
|
209
209
|
|
210
210
|
| Name | Type | Description | Notes |
|
211
211
|
| ---- | ---- | ----------- | ----- |
|
212
|
-
| **
|
212
|
+
| **storage_id** | **String** | ID of the storage. | |
|
213
213
|
|
214
214
|
### Return type
|
215
215
|
|
@@ -227,7 +227,7 @@ end
|
|
227
227
|
|
228
228
|
## storage_networks_id_patch
|
229
229
|
|
230
|
-
> <StorageNetwork> storage_networks_id_patch(
|
230
|
+
> <StorageNetwork> storage_networks_id_patch(storage_id, storage_network_update)
|
231
231
|
|
232
232
|
Update storage network details.
|
233
233
|
|
@@ -245,14 +245,12 @@ NetworkStorageApi.configure do |config|
|
|
245
245
|
end
|
246
246
|
|
247
247
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
248
|
-
|
249
|
-
|
250
|
-
storage_network_update: NetworkStorageApi::StorageNetworkUpdate.new # StorageNetworkUpdate | Storage network to be updated.
|
251
|
-
}
|
248
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
249
|
+
storage_network_update = NetworkStorageApi::StorageNetworkUpdate.new # StorageNetworkUpdate | Storage network to be updated.
|
252
250
|
|
253
251
|
begin
|
254
252
|
# Update storage network details.
|
255
|
-
result = api_instance.storage_networks_id_patch(
|
253
|
+
result = api_instance.storage_networks_id_patch(storage_id, storage_network_update)
|
256
254
|
p result
|
257
255
|
rescue NetworkStorageApi::ApiError => e
|
258
256
|
puts "Error when calling StorageNetworksApi->storage_networks_id_patch: #{e}"
|
@@ -263,12 +261,12 @@ end
|
|
263
261
|
|
264
262
|
This returns an Array which contains the response data, status code and headers.
|
265
263
|
|
266
|
-
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_id_patch_with_http_info(
|
264
|
+
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_id_patch_with_http_info(storage_id, storage_network_update)
|
267
265
|
|
268
266
|
```ruby
|
269
267
|
begin
|
270
268
|
# Update storage network details.
|
271
|
-
data, status_code, headers = api_instance.storage_networks_id_patch_with_http_info(
|
269
|
+
data, status_code, headers = api_instance.storage_networks_id_patch_with_http_info(storage_id, storage_network_update)
|
272
270
|
p status_code # => 2xx
|
273
271
|
p headers # => { ... }
|
274
272
|
p data # => <StorageNetwork>
|
@@ -281,8 +279,8 @@ end
|
|
281
279
|
|
282
280
|
| Name | Type | Description | Notes |
|
283
281
|
| ---- | ---- | ----------- | ----- |
|
284
|
-
| **
|
285
|
-
| **storage_network_update** | [**StorageNetworkUpdate**](StorageNetworkUpdate.md) | Storage network to be updated. |
|
282
|
+
| **storage_id** | **String** | ID of the storage. | |
|
283
|
+
| **storage_network_update** | [**StorageNetworkUpdate**](StorageNetworkUpdate.md) | Storage network to be updated. | |
|
286
284
|
|
287
285
|
### Return type
|
288
286
|
|
@@ -300,7 +298,7 @@ end
|
|
300
298
|
|
301
299
|
## storage_networks_post
|
302
300
|
|
303
|
-
> <StorageNetwork> storage_networks_post(
|
301
|
+
> <StorageNetwork> storage_networks_post(storage_network_create)
|
304
302
|
|
305
303
|
Create a storage network and volume.
|
306
304
|
|
@@ -318,13 +316,11 @@ NetworkStorageApi.configure do |config|
|
|
318
316
|
end
|
319
317
|
|
320
318
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
321
|
-
|
322
|
-
storage_network_create: NetworkStorageApi::StorageNetworkCreate.new({name: 'My storage network', location: 'PHX', volumes: [NetworkStorageApi::StorageNetworkVolumeCreate.new({name: 'My volume name', capacity_in_gb: 2000})]}) # StorageNetworkCreate |
|
323
|
-
}
|
319
|
+
storage_network_create = NetworkStorageApi::StorageNetworkCreate.new({name: 'My storage network', location: 'PHX', volumes: [NetworkStorageApi::StorageNetworkVolumeCreate.new({name: 'My volume name', capacity_in_gb: 2000})]}) # StorageNetworkCreate |
|
324
320
|
|
325
321
|
begin
|
326
322
|
# Create a storage network and volume.
|
327
|
-
result = api_instance.storage_networks_post(
|
323
|
+
result = api_instance.storage_networks_post(storage_network_create)
|
328
324
|
p result
|
329
325
|
rescue NetworkStorageApi::ApiError => e
|
330
326
|
puts "Error when calling StorageNetworksApi->storage_networks_post: #{e}"
|
@@ -335,12 +331,12 @@ end
|
|
335
331
|
|
336
332
|
This returns an Array which contains the response data, status code and headers.
|
337
333
|
|
338
|
-
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_post_with_http_info(
|
334
|
+
> <Array(<StorageNetwork>, Integer, Hash)> storage_networks_post_with_http_info(storage_network_create)
|
339
335
|
|
340
336
|
```ruby
|
341
337
|
begin
|
342
338
|
# Create a storage network and volume.
|
343
|
-
data, status_code, headers = api_instance.storage_networks_post_with_http_info(
|
339
|
+
data, status_code, headers = api_instance.storage_networks_post_with_http_info(storage_network_create)
|
344
340
|
p status_code # => 2xx
|
345
341
|
p headers # => { ... }
|
346
342
|
p data # => <StorageNetwork>
|
@@ -353,7 +349,7 @@ end
|
|
353
349
|
|
354
350
|
| Name | Type | Description | Notes |
|
355
351
|
| ---- | ---- | ----------- | ----- |
|
356
|
-
| **storage_network_create** | [**StorageNetworkCreate**](StorageNetworkCreate.md) | |
|
352
|
+
| **storage_network_create** | [**StorageNetworkCreate**](StorageNetworkCreate.md) | | |
|
357
353
|
|
358
354
|
### Return type
|
359
355
|
|
@@ -371,7 +367,7 @@ end
|
|
371
367
|
|
372
368
|
## storage_networks_storage_network_id_volumes_get
|
373
369
|
|
374
|
-
> <Array<Volume>> storage_networks_storage_network_id_volumes_get(
|
370
|
+
> <Array<Volume>> storage_networks_storage_network_id_volumes_get(storage_id, opts)
|
375
371
|
|
376
372
|
Display one or more volumes belonging to a storage network.
|
377
373
|
|
@@ -389,14 +385,14 @@ NetworkStorageApi.configure do |config|
|
|
389
385
|
end
|
390
386
|
|
391
387
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
392
|
-
|
388
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
393
389
|
opts = {
|
394
390
|
tag: ['inner_example'] # Array<String> | A list of query parameters related to tags in the form of tagName.tagValue
|
395
391
|
}
|
396
392
|
|
397
393
|
begin
|
398
394
|
# Display one or more volumes belonging to a storage network.
|
399
|
-
result = api_instance.storage_networks_storage_network_id_volumes_get(
|
395
|
+
result = api_instance.storage_networks_storage_network_id_volumes_get(storage_id, opts)
|
400
396
|
p result
|
401
397
|
rescue NetworkStorageApi::ApiError => e
|
402
398
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_get: #{e}"
|
@@ -407,12 +403,12 @@ end
|
|
407
403
|
|
408
404
|
This returns an Array which contains the response data, status code and headers.
|
409
405
|
|
410
|
-
> <Array(<Array<Volume>>, Integer, Hash)> storage_networks_storage_network_id_volumes_get_with_http_info(
|
406
|
+
> <Array(<Array<Volume>>, Integer, Hash)> storage_networks_storage_network_id_volumes_get_with_http_info(storage_id, opts)
|
411
407
|
|
412
408
|
```ruby
|
413
409
|
begin
|
414
410
|
# Display one or more volumes belonging to a storage network.
|
415
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_get_with_http_info(
|
411
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_get_with_http_info(storage_id, opts)
|
416
412
|
p status_code # => 2xx
|
417
413
|
p headers # => { ... }
|
418
414
|
p data # => <Array<Volume>>
|
@@ -425,7 +421,7 @@ end
|
|
425
421
|
|
426
422
|
| Name | Type | Description | Notes |
|
427
423
|
| ---- | ---- | ----------- | ----- |
|
428
|
-
| **
|
424
|
+
| **storage_id** | **String** | ID of the storage. | |
|
429
425
|
| **tag** | [**Array<String>**](String.md) | A list of query parameters related to tags in the form of tagName.tagValue | [optional] |
|
430
426
|
|
431
427
|
### Return type
|
@@ -444,7 +440,7 @@ end
|
|
444
440
|
|
445
441
|
## storage_networks_storage_network_id_volumes_post
|
446
442
|
|
447
|
-
> <Volume> storage_networks_storage_network_id_volumes_post(
|
443
|
+
> <Volume> storage_networks_storage_network_id_volumes_post(storage_id, volume_create)
|
448
444
|
|
449
445
|
Create a volume belonging to a storage network.
|
450
446
|
|
@@ -462,14 +458,12 @@ NetworkStorageApi.configure do |config|
|
|
462
458
|
end
|
463
459
|
|
464
460
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
465
|
-
|
466
|
-
|
467
|
-
volume_create: NetworkStorageApi::VolumeCreate.new({name: 'My volume name', capacity_in_gb: 2000}) # VolumeCreate |
|
468
|
-
}
|
461
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
462
|
+
volume_create = NetworkStorageApi::VolumeCreate.new({name: 'My volume name', capacity_in_gb: 2000}) # VolumeCreate |
|
469
463
|
|
470
464
|
begin
|
471
465
|
# Create a volume belonging to a storage network.
|
472
|
-
result = api_instance.storage_networks_storage_network_id_volumes_post(
|
466
|
+
result = api_instance.storage_networks_storage_network_id_volumes_post(storage_id, volume_create)
|
473
467
|
p result
|
474
468
|
rescue NetworkStorageApi::ApiError => e
|
475
469
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_post: #{e}"
|
@@ -480,12 +474,12 @@ end
|
|
480
474
|
|
481
475
|
This returns an Array which contains the response data, status code and headers.
|
482
476
|
|
483
|
-
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_post_with_http_info(
|
477
|
+
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_post_with_http_info(storage_id, volume_create)
|
484
478
|
|
485
479
|
```ruby
|
486
480
|
begin
|
487
481
|
# Create a volume belonging to a storage network.
|
488
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_post_with_http_info(
|
482
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_post_with_http_info(storage_id, volume_create)
|
489
483
|
p status_code # => 2xx
|
490
484
|
p headers # => { ... }
|
491
485
|
p data # => <Volume>
|
@@ -498,8 +492,8 @@ end
|
|
498
492
|
|
499
493
|
| Name | Type | Description | Notes |
|
500
494
|
| ---- | ---- | ----------- | ----- |
|
501
|
-
| **
|
502
|
-
| **volume_create** | [**VolumeCreate**](VolumeCreate.md) | |
|
495
|
+
| **storage_id** | **String** | ID of the storage. | |
|
496
|
+
| **volume_create** | [**VolumeCreate**](VolumeCreate.md) | | |
|
503
497
|
|
504
498
|
### Return type
|
505
499
|
|
@@ -517,7 +511,7 @@ end
|
|
517
511
|
|
518
512
|
## storage_networks_storage_network_id_volumes_volume_id_delete
|
519
513
|
|
520
|
-
> storage_networks_storage_network_id_volumes_volume_id_delete(
|
514
|
+
> storage_networks_storage_network_id_volumes_volume_id_delete(storage_id, volume_id)
|
521
515
|
|
522
516
|
Delete a Storage Network's Volume
|
523
517
|
|
@@ -535,12 +529,12 @@ NetworkStorageApi.configure do |config|
|
|
535
529
|
end
|
536
530
|
|
537
531
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
538
|
-
|
532
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
539
533
|
volume_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of volume.
|
540
534
|
|
541
535
|
begin
|
542
536
|
# Delete a Storage Network's Volume
|
543
|
-
api_instance.storage_networks_storage_network_id_volumes_volume_id_delete(
|
537
|
+
api_instance.storage_networks_storage_network_id_volumes_volume_id_delete(storage_id, volume_id)
|
544
538
|
rescue NetworkStorageApi::ApiError => e
|
545
539
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_volume_id_delete: #{e}"
|
546
540
|
end
|
@@ -550,12 +544,12 @@ end
|
|
550
544
|
|
551
545
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
552
546
|
|
553
|
-
> <Array(nil, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_delete_with_http_info(
|
547
|
+
> <Array(nil, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_delete_with_http_info(storage_id, volume_id)
|
554
548
|
|
555
549
|
```ruby
|
556
550
|
begin
|
557
551
|
# Delete a Storage Network's Volume
|
558
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_delete_with_http_info(
|
552
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_delete_with_http_info(storage_id, volume_id)
|
559
553
|
p status_code # => 2xx
|
560
554
|
p headers # => { ... }
|
561
555
|
p data # => nil
|
@@ -568,7 +562,7 @@ end
|
|
568
562
|
|
569
563
|
| Name | Type | Description | Notes |
|
570
564
|
| ---- | ---- | ----------- | ----- |
|
571
|
-
| **
|
565
|
+
| **storage_id** | **String** | ID of the storage. | |
|
572
566
|
| **volume_id** | **String** | ID of volume. | |
|
573
567
|
|
574
568
|
### Return type
|
@@ -587,7 +581,7 @@ nil (empty response body)
|
|
587
581
|
|
588
582
|
## storage_networks_storage_network_id_volumes_volume_id_get
|
589
583
|
|
590
|
-
> <Volume> storage_networks_storage_network_id_volumes_volume_id_get(
|
584
|
+
> <Volume> storage_networks_storage_network_id_volumes_volume_id_get(storage_id, volume_id)
|
591
585
|
|
592
586
|
Get a storage network's volume details.
|
593
587
|
|
@@ -605,12 +599,12 @@ NetworkStorageApi.configure do |config|
|
|
605
599
|
end
|
606
600
|
|
607
601
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
608
|
-
|
602
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
609
603
|
volume_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of volume.
|
610
604
|
|
611
605
|
begin
|
612
606
|
# Get a storage network's volume details.
|
613
|
-
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_get(
|
607
|
+
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_get(storage_id, volume_id)
|
614
608
|
p result
|
615
609
|
rescue NetworkStorageApi::ApiError => e
|
616
610
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_volume_id_get: #{e}"
|
@@ -621,12 +615,12 @@ end
|
|
621
615
|
|
622
616
|
This returns an Array which contains the response data, status code and headers.
|
623
617
|
|
624
|
-
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_get_with_http_info(
|
618
|
+
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_get_with_http_info(storage_id, volume_id)
|
625
619
|
|
626
620
|
```ruby
|
627
621
|
begin
|
628
622
|
# Get a storage network's volume details.
|
629
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_get_with_http_info(
|
623
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_get_with_http_info(storage_id, volume_id)
|
630
624
|
p status_code # => 2xx
|
631
625
|
p headers # => { ... }
|
632
626
|
p data # => <Volume>
|
@@ -639,7 +633,7 @@ end
|
|
639
633
|
|
640
634
|
| Name | Type | Description | Notes |
|
641
635
|
| ---- | ---- | ----------- | ----- |
|
642
|
-
| **
|
636
|
+
| **storage_id** | **String** | ID of the storage. | |
|
643
637
|
| **volume_id** | **String** | ID of volume. | |
|
644
638
|
|
645
639
|
### Return type
|
@@ -658,7 +652,7 @@ end
|
|
658
652
|
|
659
653
|
## storage_networks_storage_network_id_volumes_volume_id_patch
|
660
654
|
|
661
|
-
> <Volume> storage_networks_storage_network_id_volumes_volume_id_patch(
|
655
|
+
> <Volume> storage_networks_storage_network_id_volumes_volume_id_patch(storage_id, volume_id, volume_update)
|
662
656
|
|
663
657
|
Update a storage network's volume details.
|
664
658
|
|
@@ -676,15 +670,13 @@ NetworkStorageApi.configure do |config|
|
|
676
670
|
end
|
677
671
|
|
678
672
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
679
|
-
|
673
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
680
674
|
volume_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of volume.
|
681
|
-
|
682
|
-
volume_update: NetworkStorageApi::VolumeUpdate.new # VolumeUpdate | Storage network volume to be updated.
|
683
|
-
}
|
675
|
+
volume_update = NetworkStorageApi::VolumeUpdate.new # VolumeUpdate | Storage network volume to be updated.
|
684
676
|
|
685
677
|
begin
|
686
678
|
# Update a storage network's volume details.
|
687
|
-
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_patch(
|
679
|
+
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_patch(storage_id, volume_id, volume_update)
|
688
680
|
p result
|
689
681
|
rescue NetworkStorageApi::ApiError => e
|
690
682
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_volume_id_patch: #{e}"
|
@@ -695,12 +687,12 @@ end
|
|
695
687
|
|
696
688
|
This returns an Array which contains the response data, status code and headers.
|
697
689
|
|
698
|
-
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_patch_with_http_info(
|
690
|
+
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_patch_with_http_info(storage_id, volume_id, volume_update)
|
699
691
|
|
700
692
|
```ruby
|
701
693
|
begin
|
702
694
|
# Update a storage network's volume details.
|
703
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_patch_with_http_info(
|
695
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_patch_with_http_info(storage_id, volume_id, volume_update)
|
704
696
|
p status_code # => 2xx
|
705
697
|
p headers # => { ... }
|
706
698
|
p data # => <Volume>
|
@@ -713,9 +705,9 @@ end
|
|
713
705
|
|
714
706
|
| Name | Type | Description | Notes |
|
715
707
|
| ---- | ---- | ----------- | ----- |
|
716
|
-
| **
|
708
|
+
| **storage_id** | **String** | ID of the storage. | |
|
717
709
|
| **volume_id** | **String** | ID of volume. | |
|
718
|
-
| **volume_update** | [**VolumeUpdate**](VolumeUpdate.md) | Storage network volume to be updated. |
|
710
|
+
| **volume_update** | [**VolumeUpdate**](VolumeUpdate.md) | Storage network volume to be updated. | |
|
719
711
|
|
720
712
|
### Return type
|
721
713
|
|
@@ -733,7 +725,7 @@ end
|
|
733
725
|
|
734
726
|
## storage_networks_storage_network_id_volumes_volume_id_tags_put
|
735
727
|
|
736
|
-
> <Volume> storage_networks_storage_network_id_volumes_volume_id_tags_put(
|
728
|
+
> <Volume> storage_networks_storage_network_id_volumes_volume_id_tags_put(storage_id, volume_id, tag_assignment_request)
|
737
729
|
|
738
730
|
Overwrites tags assigned for the volume.
|
739
731
|
|
@@ -751,15 +743,13 @@ NetworkStorageApi.configure do |config|
|
|
751
743
|
end
|
752
744
|
|
753
745
|
api_instance = NetworkStorageApi::StorageNetworksApi.new
|
754
|
-
|
746
|
+
storage_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of the storage.
|
755
747
|
volume_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of volume.
|
756
|
-
|
757
|
-
tag_assignment_request: [NetworkStorageApi::TagAssignmentRequest.new({name: 'Environment'})] # Array<TagAssignmentRequest> | Tags to assign to the volume.
|
758
|
-
}
|
748
|
+
tag_assignment_request = [NetworkStorageApi::TagAssignmentRequest.new({name: 'Environment'})] # Array<TagAssignmentRequest> | Tags to assign to the volume.
|
759
749
|
|
760
750
|
begin
|
761
751
|
# Overwrites tags assigned for the volume.
|
762
|
-
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_tags_put(
|
752
|
+
result = api_instance.storage_networks_storage_network_id_volumes_volume_id_tags_put(storage_id, volume_id, tag_assignment_request)
|
763
753
|
p result
|
764
754
|
rescue NetworkStorageApi::ApiError => e
|
765
755
|
puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_volume_id_tags_put: #{e}"
|
@@ -770,12 +760,12 @@ end
|
|
770
760
|
|
771
761
|
This returns an Array which contains the response data, status code and headers.
|
772
762
|
|
773
|
-
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_tags_put_with_http_info(
|
763
|
+
> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_volume_id_tags_put_with_http_info(storage_id, volume_id, tag_assignment_request)
|
774
764
|
|
775
765
|
```ruby
|
776
766
|
begin
|
777
767
|
# Overwrites tags assigned for the volume.
|
778
|
-
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_tags_put_with_http_info(
|
768
|
+
data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_volume_id_tags_put_with_http_info(storage_id, volume_id, tag_assignment_request)
|
779
769
|
p status_code # => 2xx
|
780
770
|
p headers # => { ... }
|
781
771
|
p data # => <Volume>
|
@@ -788,9 +778,9 @@ end
|
|
788
778
|
|
789
779
|
| Name | Type | Description | Notes |
|
790
780
|
| ---- | ---- | ----------- | ----- |
|
791
|
-
| **
|
781
|
+
| **storage_id** | **String** | ID of the storage. | |
|
792
782
|
| **volume_id** | **String** | ID of volume. | |
|
793
|
-
| **tag_assignment_request** | [**Array<TagAssignmentRequest>**](TagAssignmentRequest.md) | Tags to assign to the volume. |
|
783
|
+
| **tag_assignment_request** | [**Array<TagAssignmentRequest>**](TagAssignmentRequest.md) | Tags to assign to the volume. | |
|
794
784
|
|
795
785
|
### Return type
|
796
786
|
|
data/docs/Volume.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **protocol** | **String** | File system protocol. Currently this field should be set to `NFS`. | [optional] |
|
15
15
|
| **status** | [**Status**](Status.md) | | [optional] |
|
16
16
|
| **created_on** | **Time** | | [optional] |
|
17
|
+
| **delete_requested_on** | **Time** | Date and time of the initial request for volume deletion. | [optional] |
|
17
18
|
| **permissions** | [**Permissions**](Permissions.md) | | [optional] |
|
18
19
|
| **tags** | [**Array<TagAssignment>**](TagAssignment.md) | The tags assigned if any. | [optional] |
|
19
20
|
|
@@ -33,6 +34,7 @@ instance = NetworkStorageApi::Volume.new(
|
|
33
34
|
protocol: NFS,
|
34
35
|
status: null,
|
35
36
|
created_on: 2021-03-13T20:24:32.491Z,
|
37
|
+
delete_requested_on: 2022-04-07T08:50:20.359Z,
|
36
38
|
permissions: null,
|
37
39
|
tags: [{"name":"stage","value":"beta"},{"name":"group","value":"discounted"}]
|
38
40
|
)
|