TopologicalInventoryIngressApiClient - the Ruby gem for the Topological Inventory Ingress API

Topological Inventory Ingress API

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen


Build a gem

To build the Ruby code into a gem:

gem build topological_inventory-ingress_api-client.gemspec

Then either install the gem locally:

gem install ./topological_inventory-ingress_api-client-1.0.0.gem

(for development, run gem install --dev ./topological_inventory-ingress_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-ingress_api-client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository:, then add the following in the Gemfile:

gem 'topological_inventory-ingress_api-client', :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-ingress_api-client'

api_instance =

  #Return this API document in JSON format
rescue TopologicalInventoryIngressApiClient::ApiError => e
  puts "Exception when calling DefaultApi->get_documentation: #{e}"

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
TopologicalInventoryIngressApiClient::DefaultApi get_documentation GET /openapi.json Return this API document in JSON format
TopologicalInventoryIngressApiClient::DefaultApi save_inventory POST /inventory save inventory

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.