docs/JobApi.md in autosde_openapi_client-1.1.25 vs docs/JobApi.md in autosde_openapi_client-1.1.26

- old
+ new

@@ -3,12 +3,10 @@ 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_pk_delete**](JobApi.md#jobs_pk_delete) | **DELETE** /jobs/{pk} | | -| [**jobs_pk_get**](JobApi.md#jobs_pk_get) | **GET** /jobs/{pk} | | | [**jobs_post**](JobApi.md#jobs_post) | **POST** /jobs | | ## jobs_get @@ -57,143 +55,9 @@ ``` ### Parameters This endpoint does not need any parameter. - -### Return type - -[**Array&lt;Job&gt;**](Job.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: */* - - -## jobs_pk_delete - -> <Array<Job>> jobs_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::JobApi.new -pk = 56 # Integer | - -begin - - result = api_instance.jobs_pk_delete(pk) - p result -rescue AutosdeOpenapiClient::ApiError => e - puts "Error when calling JobApi->jobs_pk_delete: #{e}" -end -``` - -#### Using the jobs_pk_delete_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> <Array(<Array<Job>>, Integer, Hash)> jobs_pk_delete_with_http_info(pk) - -```ruby -begin - - data, status_code, headers = api_instance.jobs_pk_delete_with_http_info(pk) - p status_code # => 2xx - p headers # => { ... } - p data # => <Array<Job>> -rescue AutosdeOpenapiClient::ApiError => e - puts "Error when calling JobApi->jobs_pk_delete_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pk** | **Integer** | | | - -### Return type - -[**Array&lt;Job&gt;**](Job.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: */* - - -## jobs_pk_get - -> <Array<Job>> jobs_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::JobApi.new -pk = 56 # Integer | - -begin - - result = api_instance.jobs_pk_get(pk) - p result -rescue AutosdeOpenapiClient::ApiError => e - puts "Error when calling JobApi->jobs_pk_get: #{e}" -end -``` - -#### Using the jobs_pk_get_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> <Array(<Array<Job>>, Integer, Hash)> jobs_pk_get_with_http_info(pk) - -```ruby -begin - - data, status_code, headers = api_instance.jobs_pk_get_with_http_info(pk) - p status_code # => 2xx - p headers # => { ... } - p data # => <Array<Job>> -rescue AutosdeOpenapiClient::ApiError => e - puts "Error when calling JobApi->jobs_pk_get_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pk** | **Integer** | | | ### Return type [**Array&lt;Job&gt;**](Job.md)