autosde_openapi_client 1.0.2 → 1.0.3

data/docs/VolumeCreate.md

@@ -1,29 +1,30 @@
-# OpenapiClient::VolumeCreate
+# AutosdeOpenapiClient::VolumeCreate
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**compliant** | **Boolean** | compliant | [optional] [default to false]
-**component_state** | **String** | component_state | [optional] 
-**name** | **String** | name | [optional] 
-**service** | **String** | !!uuid of service | [optional] 
-**size** | **Integer** | size | [optional] 
-**unmapped_since** | **Time** | unmapped_since | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compliant** | **Boolean** | compliant | [optional][default to false] |
+| **component_state** | **String** | component_state | [optional] |
+| **name** | **String** | name | [optional] |
+| **service** | **String** | !!uuid of service | [optional] |
+| **size** | **Integer** | size | [optional] |
+| **unmapped_since** | **Time** | unmapped_since | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::VolumeCreate.new(compliant: null,
-                                 component_state: null,
-                                 name: null,
-                                 service: null,
-                                 size: null,
-                                 unmapped_since: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::VolumeCreate.new(
+  compliant: null,
+  component_state: null,
+  name: null,
+  service: null,
+  size: null,
+  unmapped_since: null,
+  uuid: null
+)
 ```
 
-

data/docs/VolumeResponse.md

@@ -1,33 +1,34 @@
-# OpenapiClient::VolumeResponse
+# AutosdeOpenapiClient::VolumeResponse
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**compliant** | **Boolean** | compliant | [optional] [default to false]
-**component_state** | **String** | component_state | [optional] 
-**historical_service** | [**Service**](Service.md) |  | [optional] 
-**name** | **String** | name | [optional] 
-**service** | **String** | !!uuid of service | [optional] 
-**size** | **Integer** | size | [optional] 
-**storage_resource** | **String** | !!uuid of storage_resource | [optional] 
-**unmapped_since** | **Time** | unmapped_since | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compliant** | **Boolean** | compliant | [optional][default to false] |
+| **component_state** | **String** | component_state | [optional] |
+| **historical_service** | [**Service**](Service.md) |  | [optional] |
+| **name** | **String** | name | [optional] |
+| **service** | **String** | !!uuid of service | [optional] |
+| **size** | **Integer** | size | [optional] |
+| **storage_resource** | **String** | !!uuid of storage_resource | [optional] |
+| **unmapped_since** | **Time** | unmapped_since | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::VolumeResponse.new(compliant: null,
-                                 component_state: null,
-                                 historical_service: null,
-                                 name: null,
-                                 service: null,
-                                 size: null,
-                                 storage_resource: null,
-                                 unmapped_since: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::VolumeResponse.new(
+  compliant: null,
+  component_state: null,
+  historical_service: null,
+  name: null,
+  service: null,
+  size: null,
+  storage_resource: null,
+  unmapped_since: null,
+  uuid: null
+)
 ```
 
-

data/docs/VolumeSafeDelete.md

@@ -1,21 +1,22 @@
-# OpenapiClient::VolumeSafeDelete
+# AutosdeOpenapiClient::VolumeSafeDelete
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task_id** | **String** | task_id | [optional] 
-**uuid** | **String** | uuid | [optional] 
-**volume** | [**Volume**](Volume.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | task_id | [optional] |
+| **uuid** | **String** | uuid | [optional] |
+| **volume** | [**Volume**](Volume.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::VolumeSafeDelete.new(task_id: null,
-                                 uuid: null,
-                                 volume: null)
+instance = AutosdeOpenapiClient::VolumeSafeDelete.new(
+  task_id: null,
+  uuid: null,
+  volume: null
+)
 ```
 
-

data/docs/VolumeSafeDeleteApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::VolumeSafeDeleteApi
+# AutosdeOpenapiClient::VolumeSafeDeleteApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**safe_deletes_get**](VolumeSafeDeleteApi.md#safe_deletes_get) | **GET** /safe-deletes/ | 
-[**safe_deletes_pk_delete**](VolumeSafeDeleteApi.md#safe_deletes_pk_delete) | **DELETE** /safe-deletes/{pk} | 
-[**safe_deletes_pk_get**](VolumeSafeDeleteApi.md#safe_deletes_pk_get) | **GET** /safe-deletes/{pk} | 
-[**safe_deletes_post**](VolumeSafeDeleteApi.md#safe_deletes_post) | **POST** /safe-deletes/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**safe_deletes_get**](VolumeSafeDeleteApi.md#safe_deletes_get) | **GET** /safe-deletes/ |  |
+| [**safe_deletes_pk_delete**](VolumeSafeDeleteApi.md#safe_deletes_pk_delete) | **DELETE** /safe-deletes/{pk} |  |
+| [**safe_deletes_pk_get**](VolumeSafeDeleteApi.md#safe_deletes_pk_get) | **GET** /safe-deletes/{pk} |  |
+| [**safe_deletes_post**](VolumeSafeDeleteApi.md#safe_deletes_post) | **POST** /safe-deletes/ |  |
 
 
 ## safe_deletes_get
 
-> Array<VolumeSafeDelete> safe_deletes_get
+> <Array<VolumeSafeDelete>> safe_deletes_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::VolumeSafeDeleteApi.new
+api_instance = AutosdeOpenapiClient::VolumeSafeDeleteApi.new
 
 begin
+  
   result = api_instance.safe_deletes_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling VolumeSafeDeleteApi->safe_deletes_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_get: #{e}"
+end
+```
+
+#### Using the safe_deletes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<VolumeSafeDelete>>, Integer, Hash)> safe_deletes_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.safe_deletes_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<VolumeSafeDelete>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## safe_deletes_pk_delete
 
-> Array&lt;VolumeSafeDelete&gt; safe_deletes_pk_delete(pk)
+> <Array<VolumeSafeDelete>> safe_deletes_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::VolumeSafeDeleteApi.new
+api_instance = AutosdeOpenapiClient::VolumeSafeDeleteApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.safe_deletes_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling VolumeSafeDeleteApi->safe_deletes_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the safe_deletes_pk_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<VolumeSafeDelete>>, Integer, Hash)> safe_deletes_pk_delete_with_http_info(pk)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.safe_deletes_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<VolumeSafeDelete>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pk** | **Integer**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## safe_deletes_pk_get
 
-> Array&lt;VolumeSafeDelete&gt; safe_deletes_pk_get(pk)
+> <Array<VolumeSafeDelete>> safe_deletes_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::VolumeSafeDeleteApi.new
+api_instance = AutosdeOpenapiClient::VolumeSafeDeleteApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.safe_deletes_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling VolumeSafeDeleteApi->safe_deletes_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the safe_deletes_pk_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<VolumeSafeDelete>>, Integer, Hash)> safe_deletes_pk_get_with_http_info(pk)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.safe_deletes_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<VolumeSafeDelete>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pk** | **Integer**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,38 +210,56 @@ Name | Type | Description  | Notes
 
 ## safe_deletes_post
 
-> VolumeSafeDelete safe_deletes_post(volume_safe_delete_create)
+> <VolumeSafeDelete> safe_deletes_post(volume_safe_delete_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::VolumeSafeDeleteApi.new
-volume_safe_delete_create = OpenapiClient::VolumeSafeDeleteCreate.new # VolumeSafeDeleteCreate | 
+api_instance = AutosdeOpenapiClient::VolumeSafeDeleteApi.new
+volume_safe_delete_create = AutosdeOpenapiClient::VolumeSafeDeleteCreate.new # VolumeSafeDeleteCreate | 
 
 begin
+  
   result = api_instance.safe_deletes_post(volume_safe_delete_create)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling VolumeSafeDeleteApi->safe_deletes_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the safe_deletes_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VolumeSafeDelete>, Integer, Hash)> safe_deletes_post_with_http_info(volume_safe_delete_create)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.safe_deletes_post_with_http_info(volume_safe_delete_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VolumeSafeDelete>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling VolumeSafeDeleteApi->safe_deletes_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **volume_safe_delete_create** | [**VolumeSafeDeleteCreate**](VolumeSafeDeleteCreate.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_safe_delete_create** | [**VolumeSafeDeleteCreate**](VolumeSafeDeleteCreate.md) |  |  |
 
 ### Return type
 

data/docs/VolumeSafeDeleteCreate.md

@@ -1,17 +1,18 @@
-# OpenapiClient::VolumeSafeDeleteCreate
+# AutosdeOpenapiClient::VolumeSafeDeleteCreate
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volume** | [**Volume**](Volume.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume** | [**Volume**](Volume.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::VolumeSafeDeleteCreate.new(volume: null)
+instance = AutosdeOpenapiClient::VolumeSafeDeleteCreate.new(
+  volume: null
+)
 ```
 
-