Module: Dkron

Defined in:
lib/dkron-ruby/version.rb,
lib/dkron-ruby.rb,
lib/dkron-ruby/api_error.rb,
lib/dkron-ruby/api_client.rb,
lib/dkron-ruby/models/job.rb,
lib/dkron-ruby/api/jobs_api.rb,
lib/dkron-ruby/configuration.rb,
lib/dkron-ruby/models/member.rb,
lib/dkron-ruby/models/status.rb,
lib/dkron-ruby/models/restore.rb,
lib/dkron-ruby/api/default_api.rb,
lib/dkron-ruby/api/members_api.rb,
lib/dkron-ruby/models/execution.rb,
lib/dkron-ruby/models/processors.rb,
lib/dkron-ruby/api/executions_api.rb

Overview

#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.

OpenAPI spec version: 1.0

Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.17

Defined Under Namespace

Classes: ApiClient, ApiError, Configuration, DefaultApi, Execution, ExecutionsApi, Job, JobsApi, Member, MembersApi, Processors, Restore, Status

Constant Summary collapse

VERSION = 
'3.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Dkron.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



41
42
43
44
45
46
47
 
# File 'lib/dkron-ruby.rb', line 41

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end