autosde_openapi_client 1.0.0 → 1.0.21

data/docs/ServiceCreate.md

@@ -1,33 +1,34 @@
-# OpenapiClient::ServiceCreate
+# AutosdeOpenapiClient::ServiceCreate
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**capability_values** | [**ServiceAbstractCapabilityValue**](ServiceAbstractCapabilityValue.md) |  | [optional] 
-**component_state** | **String** | component_state | [optional] 
-**description** | **String** | description | [optional] [default to '']
-**name** | **String** | name | [optional] 
-**profile** | [**Profile**](Profile.md) |  | [optional] 
-**project** | [**AutoSDEProject**](AutoSDEProject.md) |  | [optional] 
-**provisioning_strategy** | [**ProvisioningStrategy**](ProvisioningStrategy.md) |  | [optional] 
-**uuid** | **String** | uuid | [optional] 
-**version** | **Integer** | The version of the service | [optional] [default to 1]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capability_values** | [**ServiceAbstractCapabilityValue**](ServiceAbstractCapabilityValue.md) |  | [optional] |
+| **component_state** | **String** | component_state | [optional] |
+| **description** | **String** | description | [optional][default to ''] |
+| **name** | **String** | name | [optional] |
+| **profile** | [**Profile**](Profile.md) |  | [optional] |
+| **project** | [**AutoSDEProject**](AutoSDEProject.md) |  | [optional] |
+| **provisioning_strategy** | [**ProvisioningStrategy**](ProvisioningStrategy.md) |  | [optional] |
+| **uuid** | **String** | uuid | [optional] |
+| **version** | **Integer** | The version of the service | [optional][default to 1] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::ServiceCreate.new(capability_values: null,
-                                 component_state: null,
-                                 description: null,
-                                 name: null,
-                                 profile: null,
-                                 project: null,
-                                 provisioning_strategy: null,
-                                 uuid: null,
-                                 version: null)
+instance = AutosdeOpenapiClient::ServiceCreate.new(
+  capability_values: null,
+  component_state: null,
+  description: null,
+  name: null,
+  profile: null,
+  project: null,
+  provisioning_strategy: null,
+  uuid: null,
+  version: null
+)
 ```
 
-

data/docs/ServiceResourceAttachment.md

@@ -1,23 +1,24 @@
-# OpenapiClient::ServiceResourceAttachment
+# AutosdeOpenapiClient::ServiceResourceAttachment
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**compliant** | **Boolean** | compliant | [optional] [default to false]
-**service** | [**Service**](Service.md) |  | [optional] 
-**storage_resource** | [**StorageResource**](StorageResource.md) |  | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compliant** | **Boolean** | compliant | [optional][default to false] |
+| **service** | [**Service**](Service.md) |  | [optional] |
+| **storage_resource** | [**StorageResource**](StorageResource.md) |  | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::ServiceResourceAttachment.new(compliant: null,
-                                 service: null,
-                                 storage_resource: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::ServiceResourceAttachment.new(
+  compliant: null,
+  service: null,
+  storage_resource: null,
+  uuid: null
+)
 ```
 
-

data/docs/ServiceResourceAttachmentApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::ServiceResourceAttachmentApi
+# AutosdeOpenapiClient::ServiceResourceAttachmentApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**service_resource_attchment_get**](ServiceResourceAttachmentApi.md#service_resource_attchment_get) | **GET** /service-resource-attchment/ | 
-[**service_resource_attchment_pk_delete**](ServiceResourceAttachmentApi.md#service_resource_attchment_pk_delete) | **DELETE** /service-resource-attchment/{pk} | 
-[**service_resource_attchment_pk_get**](ServiceResourceAttachmentApi.md#service_resource_attchment_pk_get) | **GET** /service-resource-attchment/{pk} | 
-[**service_resource_attchment_post**](ServiceResourceAttachmentApi.md#service_resource_attchment_post) | **POST** /service-resource-attchment/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**service_resource_attchment_get**](ServiceResourceAttachmentApi.md#service_resource_attchment_get) | **GET** /service-resource-attchment/ |  |
+| [**service_resource_attchment_pk_delete**](ServiceResourceAttachmentApi.md#service_resource_attchment_pk_delete) | **DELETE** /service-resource-attchment/{pk} |  |
+| [**service_resource_attchment_pk_get**](ServiceResourceAttachmentApi.md#service_resource_attchment_pk_get) | **GET** /service-resource-attchment/{pk} |  |
+| [**service_resource_attchment_post**](ServiceResourceAttachmentApi.md#service_resource_attchment_post) | **POST** /service-resource-attchment/ |  |
 
 
 ## service_resource_attchment_get
 
-> Array<ServiceResourceAttachment> service_resource_attchment_get
+> <Array<ServiceResourceAttachment>> service_resource_attchment_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::ServiceResourceAttachmentApi.new
+api_instance = AutosdeOpenapiClient::ServiceResourceAttachmentApi.new
 
 begin
+  
   result = api_instance.service_resource_attchment_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ServiceResourceAttachmentApi->service_resource_attchment_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_get: #{e}"
+end
+```
+
+#### Using the service_resource_attchment_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ServiceResourceAttachment>>, Integer, Hash)> service_resource_attchment_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.service_resource_attchment_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ServiceResourceAttachment>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## service_resource_attchment_pk_delete
 
-> Array&lt;ServiceResourceAttachment&gt; service_resource_attchment_pk_delete(pk)
+> <Array<ServiceResourceAttachment>> service_resource_attchment_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::ServiceResourceAttachmentApi.new
+api_instance = AutosdeOpenapiClient::ServiceResourceAttachmentApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.service_resource_attchment_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the service_resource_attchment_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<ServiceResourceAttachment>>, Integer, Hash)> service_resource_attchment_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.service_resource_attchment_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ServiceResourceAttachment>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## service_resource_attchment_pk_get
 
-> Array&lt;ServiceResourceAttachment&gt; service_resource_attchment_pk_get(pk)
+> <Array<ServiceResourceAttachment>> service_resource_attchment_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::ServiceResourceAttachmentApi.new
+api_instance = AutosdeOpenapiClient::ServiceResourceAttachmentApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.service_resource_attchment_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the service_resource_attchment_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<ServiceResourceAttachment>>, Integer, Hash)> service_resource_attchment_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.service_resource_attchment_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ServiceResourceAttachment>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## service_resource_attchment_post
 
-> Array&lt;ServiceResourceAttachment&gt; service_resource_attchment_post(service_resource_attachment)
+> <ServiceResourceAttachment> service_resource_attchment_post(service_resource_attachment)
 
 
 
-### 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::ServiceResourceAttachmentApi.new
-service_resource_attachment = OpenapiClient::ServiceResourceAttachment.new # ServiceResourceAttachment | 
+api_instance = AutosdeOpenapiClient::ServiceResourceAttachmentApi.new
+service_resource_attachment = AutosdeOpenapiClient::ServiceResourceAttachment.new # ServiceResourceAttachment | 
 
 begin
+  
   result = api_instance.service_resource_attchment_post(service_resource_attachment)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling ServiceResourceAttachmentApi->service_resource_attchment_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the service_resource_attchment_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service_resource_attachment** | [**ServiceResourceAttachment**](ServiceResourceAttachment.md)|  | 
+> <Array(<ServiceResourceAttachment>, Integer, Hash)> service_resource_attchment_post_with_http_info(service_resource_attachment)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.service_resource_attchment_post_with_http_info(service_resource_attachment)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServiceResourceAttachment>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling ServiceResourceAttachmentApi->service_resource_attchment_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_resource_attachment** | [**ServiceResourceAttachment**](ServiceResourceAttachment.md) |  |  |
 
 ### Return type
 
-[**Array&lt;ServiceResourceAttachment&gt;**](ServiceResourceAttachment.md)
+[**ServiceResourceAttachment**](ServiceResourceAttachment.md)
 
 ### Authorization
 

data/docs/Snapshot.md

@@ -0,0 +1,26 @@
+# AutosdeOpenapiClient::Snapshot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component_state** | **String** | component_state | [optional] |
+| **description** | **String** | description | [optional] |
+| **name** | **String** | name | [optional] |
+| **uuid** | **String** | uuid | [optional] |
+| **volume** | [**Volume**](Volume.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'autosde_openapi_client'
+
+instance = AutosdeOpenapiClient::Snapshot.new(
+  component_state: null,
+  description: null,
+  name: null,
+  uuid: null,
+  volume: null
+)
+```
+

data/docs/SnapshotApi.md

@@ -0,0 +1,276 @@
+# AutosdeOpenapiClient::SnapshotApi
+
+All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**snapshots_get**](SnapshotApi.md#snapshots_get) | **GET** /snapshots/ |  |
+| [**snapshots_pk_delete**](SnapshotApi.md#snapshots_pk_delete) | **DELETE** /snapshots/{pk} |  |
+| [**snapshots_pk_get**](SnapshotApi.md#snapshots_pk_get) | **GET** /snapshots/{pk} |  |
+| [**snapshots_post**](SnapshotApi.md#snapshots_post) | **POST** /snapshots/ |  |
+
+
+## snapshots_get
+
+> <Array<Snapshot>> snapshots_get
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::SnapshotApi.new
+
+begin
+  
+  result = api_instance.snapshots_get
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_get: #{e}"
+end
+```
+
+#### Using the snapshots_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Snapshot>>, Integer, Hash)> snapshots_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.snapshots_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Snapshot>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Snapshot&gt;**](Snapshot.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## snapshots_pk_delete
+
+> <Array<Snapshot>> snapshots_pk_delete(pk)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::SnapshotApi.new
+pk = 56 # Integer | 
+
+begin
+  
+  result = api_instance.snapshots_pk_delete(pk)
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_pk_delete: #{e}"
+end
+```
+
+#### Using the snapshots_pk_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Snapshot>>, Integer, Hash)> snapshots_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.snapshots_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Snapshot>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
+
+### Return type
+
+[**Array&lt;Snapshot&gt;**](Snapshot.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## snapshots_pk_get
+
+> <Array<Snapshot>> snapshots_pk_get(pk)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::SnapshotApi.new
+pk = 56 # Integer | 
+
+begin
+  
+  result = api_instance.snapshots_pk_get(pk)
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_pk_get: #{e}"
+end
+```
+
+#### Using the snapshots_pk_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Snapshot>>, Integer, Hash)> snapshots_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.snapshots_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Snapshot>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
+
+### Return type
+
+[**Array&lt;Snapshot&gt;**](Snapshot.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## snapshots_post
+
+> <Snapshot> snapshots_post(snapshot_create)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'autosde_openapi_client'
+# setup authorization
+AutosdeOpenapiClient.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AutosdeOpenapiClient::SnapshotApi.new
+snapshot_create = AutosdeOpenapiClient::SnapshotCreate.new # SnapshotCreate | 
+
+begin
+  
+  result = api_instance.snapshots_post(snapshot_create)
+  p result
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_post: #{e}"
+end
+```
+
+#### Using the snapshots_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Snapshot>, Integer, Hash)> snapshots_post_with_http_info(snapshot_create)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.snapshots_post_with_http_info(snapshot_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Snapshot>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling SnapshotApi->snapshots_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snapshot_create** | [**SnapshotCreate**](SnapshotCreate.md) |  |  |
+
+### Return type
+
+[**Snapshot**](Snapshot.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+