README.md in dkron-rb-0.11.2 vs README.md in dkron-rb-1.0.0
- old
+ new
@@ -4,12 +4,12 @@
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](https://github.com/swagger-api/swagger-codegen) project:
-- API version: 0.11.2
-- Package version: 0.10.0
+- API version: 1
+- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen
## Installation
### Build a gem
@@ -21,25 +21,25 @@
```
Then either install the gem locally:
```shell
-gem install ./dkron-rb-0.10.0.gem
+gem install ./dkron-rb-1.0.0.gem
```
-(for development, run `gem install --dev ./dkron-rb-0.10.0.gem` to install the development dependencies)
+(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](https://rubygems.org/).
Finally add this to the Gemfile:
- gem 'dkron-rb', '~> 0.10.0'
+ gem 'dkron-rb', '~> 1.0.0'
### Install from Git
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+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/GIT_USER_ID/GIT_REPO_ID.git'
+ 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:
@@ -78,9 +78,10 @@
*Dkron::JobsApi* | [**create_or_update_job**](docs/JobsApi.md#create_or_update_job) | **POST** /jobs |
*Dkron::JobsApi* | [**delete_job**](docs/JobsApi.md#delete_job) | **DELETE** /jobs/{job_name} |
*Dkron::JobsApi* | [**get_jobs**](docs/JobsApi.md#get_jobs) | **GET** /jobs |
*Dkron::JobsApi* | [**run_job**](docs/JobsApi.md#run_job) | **POST** /jobs/{job_name} |
*Dkron::JobsApi* | [**show_job_by_name**](docs/JobsApi.md#show_job_by_name) | **GET** /jobs/{job_name} |
+*Dkron::JobsApi* | [**toggle_job**](docs/JobsApi.md#toggle_job) | **POST** /jobs/{job_name}/toggle |
*Dkron::MembersApi* | [**get_member**](docs/MembersApi.md#get_member) | **GET** /members |
## Documentation for Models