Project

triglav_client

0.0
No commit activity in last 3 years
No release in over 3 years
triglav_clienttriglav-dataflow/triglav-client-rubyHomepageDocumentationSource CodeBug TrackerWiki
A ruby client library for Triglav, data-driven workflow tool
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
5,996
Stars
2
Forks
0
Watchers
2
 Releases
Current version
1.0.0
Total releases
3
First release
2017-02-23
Latest release
2017-04-19
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-11-20
Reverse Dependencies
4

 Dependencies

Development

autotest
>= 4.4.6, ~> 4.4
autotest-fsevent
>= 0.2.11, ~> 0.2
autotest-growl
>= 0.2.16, ~> 0.2
autotest-rails-pure
>= 4.1.2, ~> 4.1
rspec
>= 3.4.0, ~> 3.4
vcr
>= 3.0.1, ~> 3.0
webmock
>= 1.24.3, ~> 1.24

Runtime

json
>= 1.8.3, ~> 1.8
typhoeus
>= 1.0.1, ~> 1.0
 Project Readme

triglav_client

TriglavClient - the Ruby gem for the Triglav API

Triglav API Reference

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2017-04-19T18:47:18.255+09:00
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build triglav_client.gemspec

Then either install the gem locally:

gem install ./triglav_client-1.0.0.gem

(for development, run gem install --dev ./triglav_client-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 'triglav_client', '~> 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:

gem 'triglav_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'triglav_client'

api_instance = TriglavClient::AuthApi.new

credential = TriglavClient::Credential.new # Credential | 


begin
  result = api_instance.create_token(credential)
  p result
rescue TriglavClient::ApiError => e
  puts "Exception when calling AuthApi->create_token: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
TriglavClient::AuthApi create_token POST /auth/token
TriglavClient::AuthApi delete_token DELETE /auth/token
TriglavClient::AuthApi me GET /auth/me
TriglavClient::JobMessagesApi fetch_job_messages GET /job_messages
TriglavClient::JobMessagesApi get_last_job_message_id GET /job_messages/last_id
TriglavClient::JobsApi create_or_update_job PATCH /jobs
TriglavClient::JobsApi delete_job DELETE /jobs/{id_or_uri}
TriglavClient::JobsApi get_job GET /jobs/{id_or_uri}
TriglavClient::JobsApi list_jobs GET /jobs
TriglavClient::MessagesApi fetch_messages GET /messages
TriglavClient::MessagesApi get_last_message_id GET /messages/last_id
TriglavClient::MessagesApi send_messages POST /messages
TriglavClient::ResourcesApi create_resource POST /resources
TriglavClient::ResourcesApi delete_resource DELETE /resources/{id_or_uri}
TriglavClient::ResourcesApi get_resource GET /resources/{id_or_uri}
TriglavClient::ResourcesApi list_aggregated_resources GET /aggregated_resources
TriglavClient::ResourcesApi list_resources GET /resources
TriglavClient::ResourcesApi update_resource PATCH /resources/{id_or_uri}
TriglavClient::UsersApi create_user POST /users
TriglavClient::UsersApi delete_user DELETE /users/{id}
TriglavClient::UsersApi get_user GET /users/{id}
TriglavClient::UsersApi list_users GET /users
TriglavClient::UsersApi update_user PATCH /users/{id}

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header