dkron-rb

dkron-rb

Dkron - the Ruby gem for the Dkron REST API

You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port 8080 for API requests. All examples in this section assume that you've found a running leader at localhost:8080. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port 8080 by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the pretty=true param to format the response.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build dkron-rb.gemspec

Then either install the gem locally:

gem install ./dkron-rb-1.0.0.gem

(for development, run gem install --dev ./dkron-rb-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'dkron-rb', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'dkron-rb', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'dkron-rb'

api_instance = Dkron::DefaultApi.new

begin
  result = api_instance.busy
  p result
rescue Dkron::ApiError => e
  puts "Exception when calling DefaultApi->busy: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/v1

Class	Method	HTTP request	Description
Dkron::DefaultApi	busy	GET /busy
Dkron::DefaultApi	get_is_leader	GET /isleader
Dkron::DefaultApi	get_leader	GET /leader
Dkron::DefaultApi	leave	POST /leave
Dkron::DefaultApi	status	GET /
Dkron::ExecutionsApi	list_executions_by_job	GET /jobs/{job_name}/executions
Dkron::JobsApi	create_or_update_job	POST /jobs
Dkron::JobsApi	delete_job	DELETE /jobs/{job_name}
Dkron::JobsApi	get_jobs	GET /jobs
Dkron::JobsApi	restore	POST /restore
Dkron::JobsApi	run_job	POST /jobs/{job_name}
Dkron::JobsApi	show_job_by_name	GET /jobs/{job_name}
Dkron::JobsApi	toggle_job	POST /jobs/{job_name}/toggle
Dkron::MembersApi	get_member	GET /members

Documentation for Models

• Dkron::Execution
• Dkron::Job
• Dkron::Member
• Dkron::Processors
• Dkron::Restore
• Dkron::Status

Documentation for Authorization

All endpoints do not require authorization.