autosde_openapi_client 1.0.0 → 1.0.21

data/docs/AuthenticationApi.md

@@ -1,42 +1,59 @@
-# OpenapiClient::AuthenticationApi
+# AutosdeOpenapiClient::AuthenticationApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**token_auth_post**](AuthenticationApi.md#token_auth_post) | **POST** /token-auth | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**token_auth_post**](AuthenticationApi.md#token_auth_post) | **POST** /token-auth |  |
 
 
 ## token_auth_post
 
-> AuthResponse token_auth_post(authentication)
+> <AuthResponse> token_auth_post(authentication)
 
 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'autosde_openapi_client'
 
-api_instance = OpenapiClient::AuthenticationApi.new
-authentication = OpenapiClient::Authentication.new # Authentication | 
+api_instance = AutosdeOpenapiClient::AuthenticationApi.new
+authentication = AutosdeOpenapiClient::Authentication.new # Authentication | 
 
 begin
+  
   result = api_instance.token_auth_post(authentication)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling AuthenticationApi->token_auth_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AuthenticationApi->token_auth_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the token_auth_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> token_auth_post_with_http_info(authentication)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.token_auth_post_with_http_info(authentication)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AuthenticationApi->token_auth_post_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authentication** | [**Authentication**](Authentication.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | [**Authentication**](Authentication.md) |  |  |
 
 ### Return type
 

data/docs/AutoSDEProject.md

@@ -1,55 +1,56 @@
-# OpenapiClient::AutoSDEProject
+# AutosdeOpenapiClient::AutoSDEProject
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cores** | **Integer** | The number of instance cores that are allowed per project. doc-todo: what is a CORE?  | [optional] 
-**description** | **String** | Project description. | [optional] 
-**fixed_ips** | **Integer** | The number of fixed IP addresses that are allowed per project. This number must be equal to or greater than the number of allowed instances.  | [optional] 
-**floating_ips** | **Integer** | The number of floating IP addresses that are allowed  per project. | [optional] 
-**groups** | **Integer** | The maximum number of groups. | [optional] 
-**injected_file_content_bytes** | **Float** | The number of bytes of content that are allowed for each injected file.  | [optional] 
-**injected_file_path_bytes** | **Integer** | The number of bytes that are allowed for each injected file path.  | [optional] 
-**instances** | **Integer** | The number of instances that are allowed per project. doc-todo: what is an instance? does it mean how many projects can exist at once? | [optional] 
-**key_pairs** | **Integer** | The number of key pairs that are allowed per user. doc-todo: what is a key pair? | [optional] 
-**max_total_backup_gigabytes** | **Float** | Maximum capacity (GB) allocated to backups. | [optional] 
-**max_total_backups** | **Integer** | Maximum number of backups. A backup is a full copy of a volume stored in an external service. The service can be configured. The only supported service is Object Storage. doc-todo:WHAT IS OBJECT STORAGE? A backup can subsequently be restored from the external service to either          the same volume that the backup was originally taken from or          to a new volume. Backup and restore operations can only be carried out on          volumes that are in an unattached and available state.  | [optional] 
-**max_total_snapshots** | **Integer** | Maximum number of snapshots allowed per project. | [optional] 
-**max_total_volume_gigabytes** | **Float** | Maximum number of gigabytes allocated to volumes per project. | [optional] 
-**max_total_volumes** | **Integer** | Maximum number of provisioned volumes in the project. | [optional] 
-**metadata_items** | **Integer** | The number of metadata items that are allowed for each instance. | [optional] 
-**name** | **String** | Project name. | [optional] 
-**per_volume_gigabytes** | **Float** | The size (GB) of volumes in request  that are allowed per volume. | [optional] 
-**ram** | **Float** | The amount of instance RAM (MB) that are allowed per project. doc-todo: RAM per project, per specific project....? | [optional] 
-**security_groups** | **Integer** | The number of security groups that are allowed per project. | [optional] 
-**uuid** | **String** | UUID | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores** | **Integer** | The number of instance cores that are allowed per project. doc-todo: what is a CORE?  | [optional] |
+| **description** | **String** | Project description. | [optional] |
+| **fixed_ips** | **Integer** | The number of fixed IP addresses that are allowed per project. This number must be equal to or greater than the number of allowed instances.  | [optional] |
+| **floating_ips** | **Integer** | The number of floating IP addresses that are allowed  per project. | [optional] |
+| **groups** | **Integer** | The maximum number of groups. | [optional] |
+| **injected_file_content_bytes** | **Float** | The number of bytes of content that are allowed for each injected file.  | [optional] |
+| **injected_file_path_bytes** | **Integer** | The number of bytes that are allowed for each injected file path.  | [optional] |
+| **instances** | **Integer** | The number of instances that are allowed per project. doc-todo: what is an instance? does it mean how many projects can exist at once? | [optional] |
+| **key_pairs** | **Integer** | The number of key pairs that are allowed per user. doc-todo: what is a key pair? | [optional] |
+| **max_total_backup_gigabytes** | **Float** | Maximum capacity (GB) allocated to backups. | [optional] |
+| **max_total_backups** | **Integer** | Maximum number of backups. A backup is a full copy of a volume stored in an external service. The service can be configured. The only supported service is Object Storage. doc-todo:WHAT IS OBJECT STORAGE? A backup can subsequently be restored from the external service to either          the same volume that the backup was originally taken from or          to a new volume. Backup and restore operations can only be carried out on          volumes that are in an unattached and available state.  | [optional] |
+| **max_total_snapshots** | **Integer** | Maximum number of snapshots allowed per project. | [optional] |
+| **max_total_volume_gigabytes** | **Float** | Maximum number of gigabytes allocated to volumes per project. | [optional] |
+| **max_total_volumes** | **Integer** | Maximum number of provisioned volumes in the project. | [optional] |
+| **metadata_items** | **Integer** | The number of metadata items that are allowed for each instance. | [optional] |
+| **name** | **String** | Project name. | [optional] |
+| **per_volume_gigabytes** | **Float** | The size (GB) of volumes in request  that are allowed per volume. | [optional] |
+| **ram** | **Float** | The amount of instance RAM (MB) that are allowed per project. doc-todo: RAM per project, per specific project....? | [optional] |
+| **security_groups** | **Integer** | The number of security groups that are allowed per project. | [optional] |
+| **uuid** | **String** | UUID | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::AutoSDEProject.new(cores: null,
-                                 description: null,
-                                 fixed_ips: null,
-                                 floating_ips: null,
-                                 groups: null,
-                                 injected_file_content_bytes: null,
-                                 injected_file_path_bytes: null,
-                                 instances: null,
-                                 key_pairs: null,
-                                 max_total_backup_gigabytes: null,
-                                 max_total_backups: null,
-                                 max_total_snapshots: null,
-                                 max_total_volume_gigabytes: null,
-                                 max_total_volumes: null,
-                                 metadata_items: null,
-                                 name: null,
-                                 per_volume_gigabytes: null,
-                                 ram: null,
-                                 security_groups: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::AutoSDEProject.new(
+  cores: null,
+  description: null,
+  fixed_ips: null,
+  floating_ips: null,
+  groups: null,
+  injected_file_content_bytes: null,
+  injected_file_path_bytes: null,
+  instances: null,
+  key_pairs: null,
+  max_total_backup_gigabytes: null,
+  max_total_backups: null,
+  max_total_snapshots: null,
+  max_total_volume_gigabytes: null,
+  max_total_volumes: null,
+  metadata_items: null,
+  name: null,
+  per_volume_gigabytes: null,
+  ram: null,
+  security_groups: null,
+  uuid: null
+)
 ```
 
-

data/docs/AutoSDEProjectApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::AutoSDEProjectApi
+# AutosdeOpenapiClient::AutoSDEProjectApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**autosde_projects_get**](AutoSDEProjectApi.md#autosde_projects_get) | **GET** /autosde-projects/ | 
-[**autosde_projects_pk_delete**](AutoSDEProjectApi.md#autosde_projects_pk_delete) | **DELETE** /autosde-projects/{pk}/ | 
-[**autosde_projects_pk_get**](AutoSDEProjectApi.md#autosde_projects_pk_get) | **GET** /autosde-projects/{pk}/ | 
-[**autosde_projects_post**](AutoSDEProjectApi.md#autosde_projects_post) | **POST** /autosde-projects/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**autosde_projects_get**](AutoSDEProjectApi.md#autosde_projects_get) | **GET** /autosde-projects/ |  |
+| [**autosde_projects_pk_delete**](AutoSDEProjectApi.md#autosde_projects_pk_delete) | **DELETE** /autosde-projects/{pk}/ |  |
+| [**autosde_projects_pk_get**](AutoSDEProjectApi.md#autosde_projects_pk_get) | **GET** /autosde-projects/{pk}/ |  |
+| [**autosde_projects_post**](AutoSDEProjectApi.md#autosde_projects_post) | **POST** /autosde-projects/ |  |
 
 
 ## autosde_projects_get
 
-> Array<AutoSDEProject> autosde_projects_get
+> <Array<AutoSDEProject>> autosde_projects_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::AutoSDEProjectApi.new
+api_instance = AutosdeOpenapiClient::AutoSDEProjectApi.new
 
 begin
+  
   result = api_instance.autosde_projects_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling AutoSDEProjectApi->autosde_projects_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_get: #{e}"
+end
+```
+
+#### Using the autosde_projects_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AutoSDEProject>>, Integer, Hash)> autosde_projects_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.autosde_projects_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AutoSDEProject>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## autosde_projects_pk_delete
 
-> Array&lt;AutoSDEProject&gt; autosde_projects_pk_delete(pk)
+> <Array<AutoSDEProject>> autosde_projects_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::AutoSDEProjectApi.new
+api_instance = AutosdeOpenapiClient::AutoSDEProjectApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.autosde_projects_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling AutoSDEProjectApi->autosde_projects_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the autosde_projects_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<AutoSDEProject>>, Integer, Hash)> autosde_projects_pk_delete_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.autosde_projects_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AutoSDEProject>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_pk_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -107,38 +143,56 @@ Name | Type | Description  | Notes
 
 ## autosde_projects_pk_get
 
-> Array&lt;AutoSDEProject&gt; autosde_projects_pk_get(pk)
+> <Array<AutoSDEProject>> autosde_projects_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::AutoSDEProjectApi.new
+api_instance = AutosdeOpenapiClient::AutoSDEProjectApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.autosde_projects_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling AutoSDEProjectApi->autosde_projects_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the autosde_projects_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<AutoSDEProject>>, Integer, Hash)> autosde_projects_pk_get_with_http_info(pk)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.autosde_projects_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AutoSDEProject>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_pk_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **Integer** |  |  |
 
 ### Return type
 
@@ -156,42 +210,60 @@ Name | Type | Description  | Notes
 
 ## autosde_projects_post
 
-> Array&lt;AutoSDEProject&gt; autosde_projects_post(auto_sde_project)
+> <AutoSDEProject> autosde_projects_post(auto_sde_project)
 
 
 
-### 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::AutoSDEProjectApi.new
-auto_sde_project = OpenapiClient::AutoSDEProject.new # AutoSDEProject | 
+api_instance = AutosdeOpenapiClient::AutoSDEProjectApi.new
+auto_sde_project = AutosdeOpenapiClient::AutoSDEProject.new # AutoSDEProject | 
 
 begin
+  
   result = api_instance.autosde_projects_post(auto_sde_project)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling AutoSDEProjectApi->autosde_projects_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the autosde_projects_post_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auto_sde_project** | [**AutoSDEProject**](AutoSDEProject.md)|  | 
+> <Array(<AutoSDEProject>, Integer, Hash)> autosde_projects_post_with_http_info(auto_sde_project)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.autosde_projects_post_with_http_info(auto_sde_project)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutoSDEProject>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling AutoSDEProjectApi->autosde_projects_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_sde_project** | [**AutoSDEProject**](AutoSDEProject.md) |  |  |
 
 ### Return type
 
-[**Array&lt;AutoSDEProject&gt;**](AutoSDEProject.md)
+[**AutoSDEProject**](AutoSDEProject.md)
 
 ### Authorization