docs/StorageHostVolumeMappingApi.md in autosde_openapi_client-1.0.2 vs docs/StorageHostVolumeMappingApi.md in autosde_openapi_client-1.0.3

- old
+ new

@@ -1,45 +1,63 @@ -# OpenapiClient::StorageHostVolumeMappingApi +# AutosdeOpenapiClient::StorageHostVolumeMappingApi All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**storage_hosts_mapping_get**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_get) | **GET** /storage-hosts-mapping | -[**storage_hosts_mapping_pk_delete**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_pk_delete) | **DELETE** /storage-hosts-mapping/{pk} | -[**storage_hosts_mapping_pk_get**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_pk_get) | **GET** /storage-hosts-mapping/{pk} | -[**storage_hosts_mapping_post**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_post) | **POST** /storage-hosts-mapping | +| Method | HTTP request | Description | +| ------ | ------------ | ----------- | +| [**storage_hosts_mapping_get**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_get) | **GET** /storage-hosts-mapping | | +| [**storage_hosts_mapping_pk_delete**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_pk_delete) | **DELETE** /storage-hosts-mapping/{pk} | | +| [**storage_hosts_mapping_pk_get**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_pk_get) | **GET** /storage-hosts-mapping/{pk} | | +| [**storage_hosts_mapping_post**](StorageHostVolumeMappingApi.md#storage_hosts_mapping_post) | **POST** /storage-hosts-mapping | | - ## storage_hosts_mapping_get -> Array&lt;StorageHostVolumeMappingCreate&gt; storage_hosts_mapping_get +> <Array<StorageHostVolumeMappingCreate>> storage_hosts_mapping_get -### Example +### Examples ```ruby -# load the gem +require 'time' require 'autosde_openapi_client' # setup authorization -OpenapiClient.configure do |config| +AutosdeOpenapiClient.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = OpenapiClient::StorageHostVolumeMappingApi.new +api_instance = AutosdeOpenapiClient::StorageHostVolumeMappingApi.new begin + result = api_instance.storage_hosts_mapping_get p result -rescue OpenapiClient::ApiError => e - puts "Exception when calling StorageHostVolumeMappingApi->storage_hosts_mapping_get: #{e}" +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_get: #{e}" end ``` +#### Using the storage_hosts_mapping_get_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<Array<StorageHostVolumeMappingCreate>>, Integer, Hash)> storage_hosts_mapping_get_with_http_info + +```ruby +begin + + data, status_code, headers = api_instance.storage_hosts_mapping_get_with_http_info + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<StorageHostVolumeMappingCreate>> +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_get_with_http_info: #{e}" +end +``` + ### Parameters This endpoint does not need any parameter. ### Return type @@ -56,43 +74,61 @@ - **Accept**: */* ## storage_hosts_mapping_pk_delete -> Array&lt;StorageHostVolumeMapping&gt; storage_hosts_mapping_pk_delete(pk) +> <Array<StorageHostVolumeMapping>> storage_hosts_mapping_pk_delete(pk) -### Example +### Examples ```ruby -# load the gem +require 'time' require 'autosde_openapi_client' # setup authorization -OpenapiClient.configure do |config| +AutosdeOpenapiClient.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = OpenapiClient::StorageHostVolumeMappingApi.new +api_instance = AutosdeOpenapiClient::StorageHostVolumeMappingApi.new pk = 56 # Integer | begin + result = api_instance.storage_hosts_mapping_pk_delete(pk) p result -rescue OpenapiClient::ApiError => e - puts "Exception when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_delete: #{e}" +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_delete: #{e}" end ``` -### Parameters +#### Using the storage_hosts_mapping_pk_delete_with_http_info variant +This returns an Array which contains the response data, status code and headers. -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pk** | **Integer**| | +> <Array(<Array<StorageHostVolumeMapping>>, Integer, Hash)> storage_hosts_mapping_pk_delete_with_http_info(pk) +```ruby +begin + + data, status_code, headers = api_instance.storage_hosts_mapping_pk_delete_with_http_info(pk) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<StorageHostVolumeMapping>> +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_delete_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **pk** | **Integer** | | | + ### Return type [**Array&lt;StorageHostVolumeMapping&gt;**](StorageHostVolumeMapping.md) ### Authorization @@ -105,43 +141,61 @@ - **Accept**: */* ## storage_hosts_mapping_pk_get -> Array&lt;StorageHostVolumeMapping&gt; storage_hosts_mapping_pk_get(pk) +> <Array<StorageHostVolumeMapping>> storage_hosts_mapping_pk_get(pk) -### Example +### Examples ```ruby -# load the gem +require 'time' require 'autosde_openapi_client' # setup authorization -OpenapiClient.configure do |config| +AutosdeOpenapiClient.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = OpenapiClient::StorageHostVolumeMappingApi.new +api_instance = AutosdeOpenapiClient::StorageHostVolumeMappingApi.new pk = 56 # Integer | begin + result = api_instance.storage_hosts_mapping_pk_get(pk) p result -rescue OpenapiClient::ApiError => e - puts "Exception when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_get: #{e}" +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_get: #{e}" end ``` -### Parameters +#### Using the storage_hosts_mapping_pk_get_with_http_info variant +This returns an Array which contains the response data, status code and headers. -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pk** | **Integer**| | +> <Array(<Array<StorageHostVolumeMapping>>, Integer, Hash)> storage_hosts_mapping_pk_get_with_http_info(pk) +```ruby +begin + + data, status_code, headers = api_instance.storage_hosts_mapping_pk_get_with_http_info(pk) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<StorageHostVolumeMapping>> +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_pk_get_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **pk** | **Integer** | | | + ### Return type [**Array&lt;StorageHostVolumeMapping&gt;**](StorageHostVolumeMapping.md) ### Authorization @@ -154,41 +208,59 @@ - **Accept**: */* ## storage_hosts_mapping_post -> StorageHostVolumeMappingCreate storage_hosts_mapping_post(storage_host_volume_mapping_create) +> <StorageHostVolumeMappingCreate> storage_hosts_mapping_post(storage_host_volume_mapping_create) -### Example +### Examples ```ruby -# load the gem +require 'time' require 'autosde_openapi_client' # setup authorization -OpenapiClient.configure do |config| +AutosdeOpenapiClient.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end -api_instance = OpenapiClient::StorageHostVolumeMappingApi.new -storage_host_volume_mapping_create = OpenapiClient::StorageHostVolumeMappingCreate.new # StorageHostVolumeMappingCreate | +api_instance = AutosdeOpenapiClient::StorageHostVolumeMappingApi.new +storage_host_volume_mapping_create = AutosdeOpenapiClient::StorageHostVolumeMappingCreate.new # StorageHostVolumeMappingCreate | begin + result = api_instance.storage_hosts_mapping_post(storage_host_volume_mapping_create) p result -rescue OpenapiClient::ApiError => e - puts "Exception when calling StorageHostVolumeMappingApi->storage_hosts_mapping_post: #{e}" +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_post: #{e}" end ``` -### Parameters +#### Using the storage_hosts_mapping_post_with_http_info variant +This returns an Array which contains the response data, status code and headers. -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **storage_host_volume_mapping_create** | [**StorageHostVolumeMappingCreate**](StorageHostVolumeMappingCreate.md)| | +> <Array(<StorageHostVolumeMappingCreate>, Integer, Hash)> storage_hosts_mapping_post_with_http_info(storage_host_volume_mapping_create) + +```ruby +begin + + data, status_code, headers = api_instance.storage_hosts_mapping_post_with_http_info(storage_host_volume_mapping_create) + p status_code # => 2xx + p headers # => { ... } + p data # => <StorageHostVolumeMappingCreate> +rescue AutosdeOpenapiClient::ApiError => e + puts "Error when calling StorageHostVolumeMappingApi->storage_hosts_mapping_post_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **storage_host_volume_mapping_create** | [**StorageHostVolumeMappingCreate**](StorageHostVolumeMappingCreate.md) | | | ### Return type [**StorageHostVolumeMappingCreate**](StorageHostVolumeMappingCreate.md)