ibm_cloud_power 2.0.0 → 2.1.0

data/docs/PCloudInstancesApi.md

@@ -4,78 +4,14 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**pcloud_cloudinstances_delete**](PCloudInstancesApi.md#pcloud_cloudinstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id} | Delete a Power Cloud instance |
-| [**pcloud_cloudinstances_get**](PCloudInstancesApi.md#pcloud_cloudinstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id} | Get a cloud instance's current state or information |
-| [**pcloud_cloudinstances_put**](PCloudInstancesApi.md#pcloud_cloudinstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id} | Update or upgrade a cloud instance |
-
-
-## pcloud_cloudinstances_delete
-
-> Object pcloud_cloudinstances_delete(cloud_instance_id)
-
-Delete a Power Cloud instance
-
-### Examples
-
-```ruby
-require 'time'
-require 'ibm_cloud_power'
-
-api_instance = IbmCloudPower::PCloudInstancesApi.new
-cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
-
-begin
-  # Delete a Power Cloud instance
-  result = api_instance.pcloud_cloudinstances_delete(cloud_instance_id)
-  p result
-rescue IbmCloudPower::ApiError => e
-  puts "Error when calling PCloudInstancesApi->pcloud_cloudinstances_delete: #{e}"
-end
-```
-
-#### Using the pcloud_cloudinstances_delete_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> pcloud_cloudinstances_delete_with_http_info(cloud_instance_id)
-
-```ruby
-begin
-  # Delete a Power Cloud instance
-  data, status_code, headers = api_instance.pcloud_cloudinstances_delete_with_http_info(cloud_instance_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue IbmCloudPower::ApiError => e
-  puts "Error when calling PCloudInstancesApi->pcloud_cloudinstances_delete_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: */*
+| [**pcloud_cloudinstances_get**](PCloudInstancesApi.md#pcloud_cloudinstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id} | Get a Cloud Instance&#39;s current state/information |
 
 
 ## pcloud_cloudinstances_get
 
 > <CloudInstance> pcloud_cloudinstances_get(cloud_instance_id)
 
-Get a cloud instance's current state or information
+Get a Cloud Instance's current state/information
 
 ### Examples
 
@@ -87,7 +23,7 @@ api_instance = IbmCloudPower::PCloudInstancesApi.new
 cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
 
 begin
-  # Get a cloud instance's current state or information
+  # Get a Cloud Instance's current state/information
   result = api_instance.pcloud_cloudinstances_get(cloud_instance_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -103,7 +39,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a cloud instance's current state or information
+  # Get a Cloud Instance's current state/information
   data, status_code, headers = api_instance.pcloud_cloudinstances_get_with_http_info(cloud_instance_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -132,67 +68,3 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## pcloud_cloudinstances_put
-
-> <CloudInstance> pcloud_cloudinstances_put(cloud_instance_id, body)
-
-Update or upgrade a cloud instance
-
-### Examples
-
-```ruby
-require 'time'
-require 'ibm_cloud_power'
-
-api_instance = IbmCloudPower::PCloudInstancesApi.new
-cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
-body = IbmCloudPower::CloudInstanceUpdate.new # CloudInstanceUpdate | Parameters for updating a Power Cloud instance
-
-begin
-  # Update or upgrade a cloud instance
-  result = api_instance.pcloud_cloudinstances_put(cloud_instance_id, body)
-  p result
-rescue IbmCloudPower::ApiError => e
-  puts "Error when calling PCloudInstancesApi->pcloud_cloudinstances_put: #{e}"
-end
-```
-
-#### Using the pcloud_cloudinstances_put_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<CloudInstance>, Integer, Hash)> pcloud_cloudinstances_put_with_http_info(cloud_instance_id, body)
-
-```ruby
-begin
-  # Update or upgrade a cloud instance
-  data, status_code, headers = api_instance.pcloud_cloudinstances_put_with_http_info(cloud_instance_id, body)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <CloudInstance>
-rescue IbmCloudPower::ApiError => e
-  puts "Error when calling PCloudInstancesApi->pcloud_cloudinstances_put_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance |  |
-| **body** | [**CloudInstanceUpdate**](CloudInstanceUpdate.md) | Parameters for updating a Power Cloud instance |  |
-
-### Return type
-
-[**CloudInstance**](CloudInstance.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/PCloudJobsApi.md

@@ -6,7 +6,7 @@ All URIs are relative to *http://localhost*
 | ------ | ------------ | ----------- |
 | [**pcloud_cloudinstances_jobs_delete**](PCloudJobsApi.md#pcloud_cloudinstances_jobs_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id} | Delete a cloud instance job |
 | [**pcloud_cloudinstances_jobs_get**](PCloudJobsApi.md#pcloud_cloudinstances_jobs_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id} | List the detail of a job |
-| [**pcloud_cloudinstances_jobs_getall**](PCloudJobsApi.md#pcloud_cloudinstances_jobs_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs | List the latest jobs initiated by the cloud instance |
+| [**pcloud_cloudinstances_jobs_getall**](PCloudJobsApi.md#pcloud_cloudinstances_jobs_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs | List up to the last 5 jobs initiated by the cloud instance |
 
 
 ## pcloud_cloudinstances_jobs_delete
@@ -141,7 +141,7 @@ No authorization required
 
 > <Jobs> pcloud_cloudinstances_jobs_getall(cloud_instance_id, opts)
 
-List the latest jobs initiated by the cloud instance
+List up to the last 5 jobs initiated by the cloud instance
 
 ### Examples
 
@@ -152,13 +152,13 @@ require 'ibm_cloud_power'
 api_instance = IbmCloudPower::PCloudJobsApi.new
 cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
 opts = {
-  operation_id: 'operation_id_example', # String | ID of operation target resource (optional)
+  operation_id: 'operation_id_example', # String | Operation ID to filter jobs (optional)
   operation_target: 'cloudConnection', # String | Operation target to filter jobs (optional)
   operation_action: 'vmCapture' # String | Operation action to filter jobs (optional) vmCapture - includes operation action value (vmCapture) imageExport - includes operation action value (imageExport) imageImport - includes operation action value (imageImport) storage - includes operation action values (vmCapture,imageExport,imageImport)
 }
 
 begin
-  # List the latest jobs initiated by the cloud instance
+  # List up to the last 5 jobs initiated by the cloud instance
   result = api_instance.pcloud_cloudinstances_jobs_getall(cloud_instance_id, opts)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -174,7 +174,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List the latest jobs initiated by the cloud instance
+  # List up to the last 5 jobs initiated by the cloud instance
   data, status_code, headers = api_instance.pcloud_cloudinstances_jobs_getall_with_http_info(cloud_instance_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -189,7 +189,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance |  |
-| **operation_id** | **String** | ID of operation target resource (optional) | [optional] |
+| **operation_id** | **String** | Operation ID to filter jobs (optional) | [optional] |
 | **operation_target** | **String** | Operation target to filter jobs (optional) | [optional] |
 | **operation_action** | **String** | Operation action to filter jobs (optional) vmCapture - includes operation action value (vmCapture) imageExport - includes operation action value (imageExport) imageImport - includes operation action value (imageImport) storage - includes operation action values (vmCapture,imageExport,imageImport) | [optional] |
 

data/docs/PCloudNetworksApi.md

@@ -4,23 +4,23 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**pcloud_networks_delete**](PCloudNetworksApi.md#pcloud_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Delete a network |
-| [**pcloud_networks_get**](PCloudNetworksApi.md#pcloud_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Get a network's current state or information |
+| [**pcloud_networks_delete**](PCloudNetworksApi.md#pcloud_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Delete a Network |
+| [**pcloud_networks_get**](PCloudNetworksApi.md#pcloud_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Get a network's current state/information |
 | [**pcloud_networks_getall**](PCloudNetworksApi.md#pcloud_networks_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks | Get all networks in this cloud instance |
-| [**pcloud_networks_ports_delete**](PCloudNetworksApi.md#pcloud_networks_ports_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Delete a network port |
+| [**pcloud_networks_ports_delete**](PCloudNetworksApi.md#pcloud_networks_ports_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Delete a Network Port |
 | [**pcloud_networks_ports_get**](PCloudNetworksApi.md#pcloud_networks_ports_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Get a port's information |
 | [**pcloud_networks_ports_getall**](PCloudNetworksApi.md#pcloud_networks_ports_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports | Get all ports for this network |
 | [**pcloud_networks_ports_post**](PCloudNetworksApi.md#pcloud_networks_ports_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports | Perform port addition, deletion, and listing |
 | [**pcloud_networks_ports_put**](PCloudNetworksApi.md#pcloud_networks_ports_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Update a port's information |
-| [**pcloud_networks_post**](PCloudNetworksApi.md#pcloud_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks | Create a new network |
-| [**pcloud_networks_put**](PCloudNetworksApi.md#pcloud_networks_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Update a network |
+| [**pcloud_networks_post**](PCloudNetworksApi.md#pcloud_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks | Create a new Network |
+| [**pcloud_networks_put**](PCloudNetworksApi.md#pcloud_networks_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Update a Network |
 
 
 ## pcloud_networks_delete
 
 > Object pcloud_networks_delete(cloud_instance_id, network_id)
 
-Delete a network
+Delete a Network
 
 ### Examples
 
@@ -33,7 +33,7 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
 network_id = 'network_id_example' # String | Network ID
 
 begin
-  # Delete a network
+  # Delete a Network
   result = api_instance.pcloud_networks_delete(cloud_instance_id, network_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -49,7 +49,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete a network
+  # Delete a Network
   data, status_code, headers = api_instance.pcloud_networks_delete_with_http_info(cloud_instance_id, network_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -84,7 +84,7 @@ No authorization required
 
 > <Network> pcloud_networks_get(cloud_instance_id, network_id)
 
-Get a network's current state or information
+Get a network's current state/information
 
 ### Examples
 
@@ -97,7 +97,7 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
 network_id = 'network_id_example' # String | Network ID
 
 begin
-  # Get a network's current state or information
+  # Get a network's current state/information
   result = api_instance.pcloud_networks_get(cloud_instance_id, network_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -113,7 +113,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a network's current state or information
+  # Get a network's current state/information
   data, status_code, headers = api_instance.pcloud_networks_get_with_http_info(cloud_instance_id, network_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -214,7 +214,7 @@ No authorization required
 
 > Object pcloud_networks_ports_delete(cloud_instance_id, network_id, port_id)
 
-Delete a network port
+Delete a Network Port
 
 ### Examples
 
@@ -228,7 +228,7 @@ network_id = 'network_id_example' # String | Network ID
 port_id = 'port_id_example' # String | Port ID
 
 begin
-  # Delete a network port
+  # Delete a Network Port
   result = api_instance.pcloud_networks_ports_delete(cloud_instance_id, network_id, port_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -244,7 +244,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete a network port
+  # Delete a Network Port
   data, status_code, headers = api_instance.pcloud_networks_ports_delete_with_http_info(cloud_instance_id, network_id, port_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -546,7 +546,7 @@ No authorization required
 
 > <Network> pcloud_networks_post(cloud_instance_id, body)
 
-Create a new network
+Create a new Network
 
 ### Examples
 
@@ -559,7 +559,7 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
 body = IbmCloudPower::NetworkCreate.new({type: 'vlan'}) # NetworkCreate | Parameters for the creation of a new network
 
 begin
-  # Create a new network
+  # Create a new Network
   result = api_instance.pcloud_networks_post(cloud_instance_id, body)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -575,7 +575,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create a new network
+  # Create a new Network
   data, status_code, headers = api_instance.pcloud_networks_post_with_http_info(cloud_instance_id, body)
   p status_code # => 2xx
   p headers # => { ... }
@@ -610,7 +610,7 @@ No authorization required
 
 > <Network> pcloud_networks_put(cloud_instance_id, network_id, body)
 
-Update a network
+Update a Network
 
 ### Examples
 
@@ -624,7 +624,7 @@ network_id = 'network_id_example' # String | Network ID
 body = IbmCloudPower::NetworkUpdate.new # NetworkUpdate | Parameters to update a Network
 
 begin
-  # Update a network
+  # Update a Network
   result = api_instance.pcloud_networks_put(cloud_instance_id, network_id, body)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -640,7 +640,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update a network
+  # Update a Network
   data, status_code, headers = api_instance.pcloud_networks_put_with_http_info(cloud_instance_id, network_id, body)
   p status_code # => 2xx
   p headers # => { ... }