topological_inventory-api-client
TopologicalInventoryApiClient - the Ruby gem for the Topological Inventory
Topological Inventory
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build topological_inventory-api-client.gemspec
Then either install the gem locally:
gem install ./topological_inventory-api-client-1.0.0.gem
(for development, run gem install --dev ./topological_inventory-api-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 'topological_inventory-api-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 'topological_inventory-api-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 'topological_inventory-api-client'
# Setup authorization
TopologicalInventoryApiClient.configure do |config|
# Configure HTTP basic authorization: UserSecurity
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = TopologicalInventoryApiClient::DefaultApi.new
authentication = TopologicalInventoryApiClient::Authentication.new # Authentication | Authentication attributes to create
begin
#Create a new Authentication
result = api_instance.create_authentication(authentication)
p result
rescue TopologicalInventoryApiClient::ApiError => e
puts "Exception when calling DefaultApi->create_authentication: #{e}"
end
Documentation
License
This project is available as open source under the terms of the Apache License 2.0.