pnap_network_storage_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1dbf60ff5d211a65d2bf9a7fde2c7f425653919524fd8f6b2c5b5279c0716e53
+  data.tar.gz: 60133f7d3deb4919e0a81f81520fdc2d69875a716786ecc762d3a8677fe62179
+SHA512:
+  metadata.gz: d83a67049fa097656a2577744a0a26c01d469a5b762766c3eaa5dd66748b061fbf3b10c6fbfa372700e38a7e8ce242bf8c1bbfb15b99c3601e4a520b53d9a137
+  data.tar.gz: 1f84c9b0a8e4c70643066743d6bd469d0439b750eacb5c44b59ef432c28ed8a1c318b6813804ef3533ff9d7ea9a8efba738fe0a333462d95af4e8ee9098f1630

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,158 @@
+# pnap_network_storage_api
+
+NetworkStorageApi - the Ruby gem for the Network Storage API
+
+Create, list, edit, and delete storage networks with the Network Storage API. Use storage networks to expand storage capacity on a private network.
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/bare-metal-cloud-storage' target='_blank'>here</a>
+</span>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/network-storage/v1/)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_network_storage_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_network_storage_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_network_storage_api-<VERSION>.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pnap_network_storage_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_network_storage_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'NetworkStorageApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_network_storage_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'NetworkStorageApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_network_storage_api'
+
+# Setup authorization
+NetworkStorageApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkStorageApi::StorageNetworksApi.new
+opts = {
+  location: 'PHX' # String | If present will filter the result by the given location.
+}
+
+begin
+  #List all storage networks.
+  result = api_instance.storage_networks_get(opts)
+  p result
+rescue NetworkStorageApi::ApiError => e
+  puts "Exception when calling StorageNetworksApi->storage_networks_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_network_storage_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+NetworkStorageApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/network-storage/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_get**](docs/StorageNetworksApi.md#storage_networks_get) | **GET** /storage-networks | List all storage networks.
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_delete**](docs/StorageNetworksApi.md#storage_networks_id_delete) | **DELETE** /storage-networks/{storageNetworkId} | Delete a storage network and its volume.
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_get**](docs/StorageNetworksApi.md#storage_networks_id_get) | **GET** /storage-networks/{storageNetworkId} | Get storage network details.
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_patch**](docs/StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageNetworkId} | Update storage network details.
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_post**](docs/StorageNetworksApi.md#storage_networks_post) | **POST** /storage-networks | Create a storage network and volume.
+*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.
+*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.
+
+
+## Documentation for Models
+
+ - [NetworkStorageApi::Error](docs/Error.md)
+ - [NetworkStorageApi::NfsPermissions](docs/NfsPermissions.md)
+ - [NetworkStorageApi::Permissions](docs/Permissions.md)
+ - [NetworkStorageApi::Status](docs/Status.md)
+ - [NetworkStorageApi::StorageNetwork](docs/StorageNetwork.md)
+ - [NetworkStorageApi::StorageNetworkCreate](docs/StorageNetworkCreate.md)
+ - [NetworkStorageApi::StorageNetworkUpdate](docs/StorageNetworkUpdate.md)
+ - [NetworkStorageApi::Volume](docs/Volume.md)
+ - [NetworkStorageApi::VolumeCreate](docs/VolumeCreate.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - networkstorage: Grants full access to Network Storage API.
+  - networkstorage.read: Grants read only access to Network Storage API.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/Error.md

@@ -0,0 +1,20 @@
+# NetworkStorageApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/NfsPermissions.md

@@ -0,0 +1,26 @@
+# NetworkStorageApi::NfsPermissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **read_write** | **Array<String>** | Read/Write access. | [optional] |
+| **read_only** | **Array<String>** | Read only access. | [optional] |
+| **root_squash** | **Array<String>** | Root squash permission. | [optional] |
+| **no_squash** | **Array<String>** | No squash permission. | [optional] |
+| **all_squash** | **Array<String>** | All squash permission. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::NfsPermissions.new(
+  read_write: ["100.80.0.5","100.80.0.6"],
+  read_only: ["100.80.0.5"],
+  root_squash: ["100.80.0.5","100.80.0.4/24"],
+  no_squash: ["100.80.0.7","100.80.0.*"],
+  all_squash: ["100.80.0.5","100.80.0.6"]
+)
+```
+

data/docs/Permissions.md

@@ -0,0 +1,18 @@
+# NetworkStorageApi::Permissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nfs** | [**NfsPermissions**](NfsPermissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::Permissions.new(
+  nfs: null
+)
+```
+

data/docs/Status.md

@@ -0,0 +1,15 @@
+# NetworkStorageApi::Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::Status.new()
+```
+

data/docs/StorageNetwork.md

@@ -0,0 +1,34 @@
+# NetworkStorageApi::StorageNetwork
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Storage network ID. | [optional] |
+| **name** | **String** | Storage network friendly name. | [optional] |
+| **description** | **String** | Storage network description. | [optional] |
+| **status** | [**Status**](Status.md) |  | [optional] |
+| **location** | **String** | Location of storage network. Currently this field should be set to `PHX` or `ASH`. | [optional] |
+| **network_id** | **String** | Id of network the storage belongs to. | [optional] |
+| **ips** | **Array<String>** | IP of the storage network. | [optional] |
+| **created_on** | **Time** | Date and time when this storage network was created. | [optional] |
+| **volumes** | [**Array<Volume>**](Volume.md) | Volume for a storage network. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::StorageNetwork.new(
+  id: 603f3b2cfcaf050643b89a4b,
+  name: My storage network,
+  description: My storage network description,
+  status: null,
+  location: PHX,
+  network_id: 603f3b2cfcaf050643b89a4b,
+  ips: ["100.64.0.1","100.64.0.2"],
+  created_on: 2021-03-13T20:24:32.491Z,
+  volumes: null
+)
+```
+

data/docs/StorageNetworkCreate.md

@@ -0,0 +1,24 @@
+# NetworkStorageApi::StorageNetworkCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Storage network friendly name. |  |
+| **description** | **String** | Storage network description. | [optional] |
+| **location** | **String** | Location of storage network. Currently this field should be set to `PHX`. |  |
+| **volumes** | [**Array<VolumeCreate>**](VolumeCreate.md) | Volume to be created alongside storage. Currently only 1 volume is supported. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::StorageNetworkCreate.new(
+  name: My storage network,
+  description: My storage network description,
+  location: PHX,
+  volumes: null
+)
+```
+

data/docs/StorageNetworkUpdate.md

@@ -0,0 +1,20 @@
+# NetworkStorageApi::StorageNetworkUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Storage network friendly name. | [optional] |
+| **description** | **String** | Storage network description. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_storage_api'
+
+instance = NetworkStorageApi::StorageNetworkUpdate.new(
+  name: My storage network,
+  description: My storage network description
+)
+```
+