autosde_openapi_client 1.0.2 → 1.0.3

data/docs/JobApi.md

@@ -1,38 +1,56 @@
-# OpenapiClient::JobApi
+# AutosdeOpenapiClient::JobApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**jobs_get**](JobApi.md#jobs_get) | **GET** /jobs | 
-[**jobs_post**](JobApi.md#jobs_post) | **POST** /jobs | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**jobs_get**](JobApi.md#jobs_get) | **GET** /jobs |  |
+| [**jobs_post**](JobApi.md#jobs_post) | **POST** /jobs |  |
 
 
 ## jobs_get
 
-> Array<Job> jobs_get
+> <Array<Job>> jobs_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::JobApi.new
+api_instance = AutosdeOpenapiClient::JobApi.new
 
 begin
+  
   result = api_instance.jobs_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling JobApi->jobs_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_get: #{e}"
+end
+```
+
+#### Using the jobs_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Job>>, Integer, Hash)> jobs_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jobs_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Job>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_get_with_http_info: #{e}"
 end
 ```
 
@@ -56,38 +74,56 @@ This endpoint does not need any parameter.
 
 ## jobs_post
 
-> Job jobs_post(job_create)
+> <Job> jobs_post(job_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::JobApi.new
-job_create = OpenapiClient::JobCreate.new # JobCreate | 
+api_instance = AutosdeOpenapiClient::JobApi.new
+job_create = AutosdeOpenapiClient::JobCreate.new # JobCreate | 
 
 begin
+  
   result = api_instance.jobs_post(job_create)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling JobApi->jobs_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the jobs_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Job>, Integer, Hash)> jobs_post_with_http_info(job_create)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jobs_post_with_http_info(job_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Job>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling JobApi->jobs_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **job_create** | [**JobCreate**](JobCreate.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_create** | [**JobCreate**](JobCreate.md) |  |  |
 
 ### Return type
 

data/docs/JobCreate.md

@@ -1,19 +1,20 @@
-# OpenapiClient::JobCreate
+# AutosdeOpenapiClient::JobCreate
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task_args** | **String** | task_args | [optional] 
-**task_name** | **String** | task_name | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_args** | **String** | task_args | [optional] |
+| **task_name** | **String** | task_name | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::JobCreate.new(task_args: null,
-                                 task_name: null)
+instance = AutosdeOpenapiClient::JobCreate.new(
+  task_args: null,
+  task_name: null
+)
 ```
 
-

data/docs/NativeCapability.md

@@ -1,23 +1,24 @@
-# OpenapiClient::NativeCapability
+# AutosdeOpenapiClient::NativeCapability
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | name | [optional] 
-**published** | **Boolean** | published | [optional] [default to true]
-**system_type** | [**SystemType**](SystemType.md) |  | [optional] 
-**uuid** | **String** | uuid | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name | [optional] |
+| **published** | **Boolean** | published | [optional][default to true] |
+| **system_type** | [**SystemType**](SystemType.md) |  | [optional] |
+| **uuid** | **String** | uuid | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OpenapiClient'
+require 'autosde_openapi_client'
 
-instance = OpenapiClient::NativeCapability.new(name: null,
-                                 published: null,
-                                 system_type: null,
-                                 uuid: null)
+instance = AutosdeOpenapiClient::NativeCapability.new(
+  name: null,
+  published: null,
+  system_type: null,
+  uuid: null
+)
 ```
 
-

data/docs/NativeCapabilityApi.md

@@ -1,40 +1,58 @@
-# OpenapiClient::NativeCapabilityApi
+# AutosdeOpenapiClient::NativeCapabilityApi
 
 All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**native_capabilities_get**](NativeCapabilityApi.md#native_capabilities_get) | **GET** /native-capabilities/ | 
-[**native_capabilities_pk_delete**](NativeCapabilityApi.md#native_capabilities_pk_delete) | **DELETE** /native-capabilities/{pk} | 
-[**native_capabilities_pk_get**](NativeCapabilityApi.md#native_capabilities_pk_get) | **GET** /native-capabilities/{pk} | 
-[**native_capabilities_post**](NativeCapabilityApi.md#native_capabilities_post) | **POST** /native-capabilities/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**native_capabilities_get**](NativeCapabilityApi.md#native_capabilities_get) | **GET** /native-capabilities/ |  |
+| [**native_capabilities_pk_delete**](NativeCapabilityApi.md#native_capabilities_pk_delete) | **DELETE** /native-capabilities/{pk} |  |
+| [**native_capabilities_pk_get**](NativeCapabilityApi.md#native_capabilities_pk_get) | **GET** /native-capabilities/{pk} |  |
+| [**native_capabilities_post**](NativeCapabilityApi.md#native_capabilities_post) | **POST** /native-capabilities/ |  |
 
 
 ## native_capabilities_get
 
-> Array<NativeCapability> native_capabilities_get
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 
 begin
+  
   result = api_instance.native_capabilities_get
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_get: #{e}"
+end
+```
+
+#### Using the native_capabilities_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<NativeCapability>>, Integer, Hash)> native_capabilities_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_get_with_http_info: #{e}"
 end
 ```
 
@@ -58,38 +76,56 @@ This endpoint does not need any parameter.
 
 ## native_capabilities_pk_delete
 
-> Array&lt;NativeCapability&gt; native_capabilities_pk_delete(pk)
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.native_capabilities_pk_delete(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_pk_delete: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_pk_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<NativeCapability>>, Integer, Hash)> native_capabilities_pk_delete_with_http_info(pk)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_pk_delete_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_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
 
 ## native_capabilities_pk_get
 
-> Array&lt;NativeCapability&gt; native_capabilities_pk_get(pk)
+> <Array<NativeCapability>> native_capabilities_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::NativeCapabilityApi.new
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
 pk = 56 # Integer | 
 
 begin
+  
   result = api_instance.native_capabilities_pk_get(pk)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_pk_get: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_pk_get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_pk_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<NativeCapability>>, Integer, Hash)> native_capabilities_pk_get_with_http_info(pk)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_pk_get_with_http_info(pk)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<NativeCapability>>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_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
 
 ## native_capabilities_post
 
-> NativeCapability native_capabilities_post(native_capability)
+> <NativeCapability> native_capabilities_post(native_capability)
 
 
 
-### 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::NativeCapabilityApi.new
-native_capability = OpenapiClient::NativeCapability.new # NativeCapability | 
+api_instance = AutosdeOpenapiClient::NativeCapabilityApi.new
+native_capability = AutosdeOpenapiClient::NativeCapability.new # NativeCapability | 
 
 begin
+  
   result = api_instance.native_capabilities_post(native_capability)
   p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling NativeCapabilityApi->native_capabilities_post: #{e}"
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_post: #{e}"
 end
 ```
 
-### Parameters
+#### Using the native_capabilities_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NativeCapability>, Integer, Hash)> native_capabilities_post_with_http_info(native_capability)
 
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.native_capabilities_post_with_http_info(native_capability)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NativeCapability>
+rescue AutosdeOpenapiClient::ApiError => e
+  puts "Error when calling NativeCapabilityApi->native_capabilities_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **native_capability** | [**NativeCapability**](NativeCapability.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **native_capability** | [**NativeCapability**](NativeCapability.md) |  |  |
 
 ### Return type