docs/JobsApi.md in dkron-rb-0.11.2 vs docs/JobsApi.md in dkron-rb-1.0.0

- old
+ new

@@ -7,10 +7,11 @@ [**create_or_update_job**](JobsApi.md#create_or_update_job) | **POST** /jobs | [**delete_job**](JobsApi.md#delete_job) | **DELETE** /jobs/{job_name} | [**get_jobs**](JobsApi.md#get_jobs) | **GET** /jobs | [**run_job**](JobsApi.md#run_job) | **POST** /jobs/{job_name} | [**show_job_by_name**](JobsApi.md#show_job_by_name) | **GET** /jobs/{job_name} | +[**toggle_job**](JobsApi.md#toggle_job) | **POST** /jobs/{job_name}/toggle | # **create_or_update_job** > Job create_or_update_job(body) @@ -69,11 +70,11 @@ # load the gem require 'dkron-rb' api_instance = Dkron::JobsApi.new -job_name = "job_name_example" # String | The job that needs to be deleted. +job_name = 'job_name_example' # String | The job that needs to be deleted. begin result = api_instance.delete_job(job_name) p result @@ -102,11 +103,11 @@ - **Accept**: application/json # **get_jobs** -> Array&lt;Job&gt; get_jobs +> Array&lt;Job&gt; get_jobs(opts) List jobs. @@ -115,21 +116,28 @@ # load the gem require 'dkron-rb' api_instance = Dkron::JobsApi.new +opts = { + tags: ['tags_example'] # Array<String> | Filter jobs by tags +} + begin - result = api_instance.get_jobs + result = api_instance.get_jobs(opts) p result rescue Dkron::ApiError => e puts "Exception when calling JobsApi->get_jobs: #{e}" end ``` ### Parameters -This endpoint does not need any parameter. +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**Array&lt;String&gt;**](String.md)| Filter jobs by tags | [optional] + ### Return type [**Array&lt;Job&gt;**](Job.md) ### Authorization @@ -155,11 +163,11 @@ # load the gem require 'dkron-rb' api_instance = Dkron::JobsApi.new -job_name = "job_name_example" # String | The job that needs to be run. +job_name = 'job_name_example' # String | The job that needs to be run. begin result = api_instance.run_job(job_name) p result @@ -201,11 +209,11 @@ # load the gem require 'dkron-rb' api_instance = Dkron::JobsApi.new -job_name = "job_name_example" # String | The job that needs to be fetched. +job_name = 'job_name_example' # String | The job that needs to be fetched. begin result = api_instance.show_job_by_name(job_name) p result @@ -217,9 +225,55 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **job_name** | **String**| The job that needs to be fetched. | + +### Return type + +[**Job**](Job.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **toggle_job** +> Job toggle_job(job_name) + + + +Toggle a job. + +### Example +```ruby +# load the gem +require 'dkron-rb' + +api_instance = Dkron::JobsApi.new + +job_name = 'job_name_example' # String | The job that needs to be toggled. + + +begin + result = api_instance.toggle_job(job_name) + p result +rescue Dkron::ApiError => e + puts "Exception when calling JobsApi->toggle_job: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_name** | **String**| The job that needs to be toggled. | ### Return type [**Job**](Job.md)