pnap_network_storage_api 1.3.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -8
  3. data/VERSION +1 -1
  4. data/docs/StorageNetwork.md +2 -0
  5. data/docs/StorageNetworkCreate.md +3 -1
  6. data/docs/StorageNetworkVolumeCreate.md +3 -1
  7. data/docs/StorageNetworksApi.md +146 -76
  8. data/docs/TagAssignment.md +26 -0
  9. data/docs/TagAssignmentRequest.md +20 -0
  10. data/docs/Volume.md +5 -1
  11. data/docs/VolumeCreate.md +3 -1
  12. data/lib/pnap_network_storage_api/api/storage_networks_api.rb +187 -88
  13. data/lib/pnap_network_storage_api/api_client.rb +24 -21
  14. data/lib/pnap_network_storage_api/api_error.rb +2 -1
  15. data/lib/pnap_network_storage_api/configuration.rb +28 -9
  16. data/lib/pnap_network_storage_api/models/error.rb +16 -19
  17. data/lib/pnap_network_storage_api/models/nfs_permissions.rb +14 -19
  18. data/lib/pnap_network_storage_api/models/nfs_permissions_create.rb +14 -19
  19. data/lib/pnap_network_storage_api/models/nfs_permissions_update.rb +14 -19
  20. data/lib/pnap_network_storage_api/models/permissions.rb +14 -19
  21. data/lib/pnap_network_storage_api/models/permissions_create.rb +14 -19
  22. data/lib/pnap_network_storage_api/models/permissions_update.rb +14 -19
  23. data/lib/pnap_network_storage_api/models/status.rb +8 -4
  24. data/lib/pnap_network_storage_api/models/storage_network.rb +47 -20
  25. data/lib/pnap_network_storage_api/models/storage_network_create.rb +78 -24
  26. data/lib/pnap_network_storage_api/models/storage_network_update.rb +36 -22
  27. data/lib/pnap_network_storage_api/models/storage_network_volume_create.rb +57 -27
  28. data/lib/pnap_network_storage_api/models/tag_assignment.rb +311 -0
  29. data/lib/pnap_network_storage_api/models/tag_assignment_request.rb +233 -0
  30. data/lib/pnap_network_storage_api/models/volume.rb +62 -23
  31. data/lib/pnap_network_storage_api/models/volume_create.rb +57 -27
  32. data/lib/pnap_network_storage_api/models/volume_update.rb +48 -26
  33. data/lib/pnap_network_storage_api/version.rb +1 -1
  34. data/lib/pnap_network_storage_api.rb +3 -1
  35. data/pnap_network_storage_api.gemspec +2 -2
  36. data/spec/api/storage_networks_api_spec.rb +70 -15
  37. data/spec/models/error_spec.rb +6 -4
  38. data/spec/models/nfs_permissions_create_spec.rb +9 -7
  39. data/spec/models/nfs_permissions_spec.rb +9 -7
  40. data/spec/models/nfs_permissions_update_spec.rb +9 -7
  41. data/spec/models/permissions_create_spec.rb +5 -3
  42. data/spec/models/permissions_spec.rb +5 -3
  43. data/spec/models/permissions_update_spec.rb +5 -3
  44. data/spec/models/status_spec.rb +4 -2
  45. data/spec/models/storage_network_create_spec.rb +14 -6
  46. data/spec/models/storage_network_spec.rb +19 -11
  47. data/spec/models/storage_network_update_spec.rb +6 -4
  48. data/spec/models/storage_network_volume_create_spec.rb +14 -6
  49. data/spec/models/tag_assignment_request_spec.rb +42 -0
  50. data/spec/models/tag_assignment_spec.rb +64 -0
  51. data/spec/models/volume_create_spec.rb +20 -6
  52. data/spec/models/volume_spec.rb +32 -12
  53. data/spec/models/volume_update_spec.rb +29 -3
  54. data/spec/spec_helper.rb +1 -1
  55. metadata +20 -16
  56. data/spec/api_client_spec.rb +0 -226
  57. data/spec/configuration_spec.rb +0 -42
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d120bcac5267b846f83dbc1ea051aee392e9b82300931c585dfdcac8cadb63a
4
- data.tar.gz: bcd0e1bbb133621426684eaf5e2458e577b929abb6c7178e82e1bb036b79f47d
3
+ metadata.gz: fe73d1f150bea15913ed78cc9111346309fbfaa44f20b14eee52c785a954c599
4
+ data.tar.gz: 79bca51791dce6f303e5fa4e813ef199dd2b0fd0e0f135c4018920702dccd8e2
5
5
  SHA512:
6
- metadata.gz: 239ff1a8f22703984c1ff835bd980a0327182efbdeab62e9d47abfd850faa52bd832e95138890ef732cacfbe2ff7ed74cff5235e40b834fc513ffbe5a2944c61
7
- data.tar.gz: ccc43adb4c49d25efd01379afbd3b60ab0b67817814b68a4a0b5b0345c21ec570f715f845c6c32eb36012c3e2e9ee587e10f446bda2a94c2d825bc95b56cac12
6
+ metadata.gz: 031f3f23188c88def0977ce6bce8b3fda5cef4678cbbac39a47773d6782e054e62422604a6a43290ec728ae664296a7d5eaec01f4df0f0849efa6ecc0f708750
7
+ data.tar.gz: 720e6560155faeddca7d4de411ace71def59715ddd7e5f41c9691e7870c59e6b8d7f3802a63ac41ee5677c5b71c4e133077a1983b9c55a38744c0a821f305063
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,15 +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/{storageNetworkId} | Delete a storage network and its volume.
126
- *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_get**](docs/StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{storageNetworkId} | Get storage network details.
127
- *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_patch**](docs/StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageNetworkId} | Update storage network details.
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/{storageNetworkId}/volumes | Display one or more volumes belonging to a storage network.
130
- *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_post**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{storageNetworkId}/volumes | Create a volume belonging to a storage network.
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/{storageNetworkId}/volumes/{volumeId} | Delete a Storage Network's Volume
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/{storageNetworkId}/volumes/{volumeId} | Get a storage network's volume details.
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/{storageNetworkId}/volumes/{volumeId} | Update a storage network's volume details.
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.
134
137
 
135
138
 
136
139
  ## Documentation for Models
@@ -147,6 +150,8 @@ Class | Method | HTTP request | Description
147
150
  - [NetworkStorageApi::StorageNetworkCreate](docs/StorageNetworkCreate.md)
148
151
  - [NetworkStorageApi::StorageNetworkUpdate](docs/StorageNetworkUpdate.md)
149
152
  - [NetworkStorageApi::StorageNetworkVolumeCreate](docs/StorageNetworkVolumeCreate.md)
153
+ - [NetworkStorageApi::TagAssignment](docs/TagAssignment.md)
154
+ - [NetworkStorageApi::TagAssignmentRequest](docs/TagAssignmentRequest.md)
150
155
  - [NetworkStorageApi::Volume](docs/Volume.md)
151
156
  - [NetworkStorageApi::VolumeCreate](docs/VolumeCreate.md)
152
157
  - [NetworkStorageApi::VolumeUpdate](docs/VolumeUpdate.md)
@@ -155,6 +160,7 @@ Class | Method | HTTP request | Description
155
160
  ## Documentation for Authorization
156
161
 
157
162
 
163
+ Authentication schemes defined for the API:
158
164
  ### OAuth2
159
165
 
160
166
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.3.0
1
+ 2.0.0
@@ -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
  ```
@@ -8,6 +8,7 @@
8
8
  | **description** | **String** | Storage network description. | [optional] |
9
9
  | **location** | **String** | Location of storage network. Currently this field should be set to `PHX` or `ASH`. | |
10
10
  | **volumes** | [**Array<StorageNetworkVolumeCreate>**](StorageNetworkVolumeCreate.md) | Volume to be created alongside storage. Currently only 1 volume is supported. | |
11
+ | **client_vlan** | **Integer** | Custom Client VLAN that the Storage Network will be set to. | [optional] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = NetworkStorageApi::StorageNetworkCreate.new(
18
19
  name: My storage network,
19
20
  description: My storage network description,
20
21
  location: PHX,
21
- volumes: null
22
+ volumes: null,
23
+ client_vlan: null
22
24
  )
23
25
  ```
24
26
 
@@ -8,6 +8,7 @@
8
8
  | **description** | **String** | Volume description. | [optional] |
9
9
  | **path_suffix** | **String** | Last part of volume's path. | [optional] |
10
10
  | **capacity_in_gb** | **Integer** | Capacity of Volume in GB. Currently only whole numbers and multiples of 1000GB are supported. | |
11
+ | **tags** | [**Array<TagAssignmentRequest>**](TagAssignmentRequest.md) | Tags to set to the resource. To create a new tag or list all the existing tags that you can use, refer to [Tags API](https://developers.phoenixnap.com/docs/tags/1/overview). | [optional] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = NetworkStorageApi::StorageNetworkVolumeCreate.new(
18
19
  name: My volume name,
19
20
  description: My volume description,
20
21
  path_suffix: /shared-docs,
21
- capacity_in_gb: 2000
22
+ capacity_in_gb: 2000,
23
+ tags: [{"name":"stage","value":"beta"},{"name":"group","value":"discounted"}]
22
24
  )
23
25
  ```
24
26