topological_inventory v1.0.0

topological_inventory

To be used by topology_inventory_ui and others.

TopologicalInventory - JavaScript client for topological_inventory Topological Inventory This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install topological_inventory --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TopologicalInventory = require('topological_inventory');

var defaultClient = TopologicalInventory.ApiClient.instance;

// Configure HTTP basic authorization: UserSecurity
var UserSecurity = defaultClient.authentications['UserSecurity'];
UserSecurity.username = 'YOUR USERNAME'
UserSecurity.password = 'YOUR PASSWORD'

var api = new TopologicalInventory.DefaultApi()

var body = new TopologicalInventory.ID(); // {ID} 

api.createAuthentication(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/r/insights/platform/topological-inventory/v0.0

Documentation for Models

• TopologicalInventory.Authentication
• TopologicalInventory.Container
• TopologicalInventory.ContainerGroup
• TopologicalInventory.ContainerImage
• TopologicalInventory.ContainerNode
• TopologicalInventory.ContainerProject
• TopologicalInventory.ContainerTemplate
• TopologicalInventory.Endpoint
• TopologicalInventory.Flavor
• TopologicalInventory.InlineResponse200
• TopologicalInventory.OrchestrationStack
• TopologicalInventory.OrderParameters
• TopologicalInventory.ServiceInstance
• TopologicalInventory.ServiceOffering
• TopologicalInventory.ServicePlan
• TopologicalInventory.Source
• TopologicalInventory.SourceType
• TopologicalInventory.Task
• TopologicalInventory.Vm
• TopologicalInventory.Volume
• TopologicalInventory.VolumeAttachment
• TopologicalInventory.VolumeType

Documentation for Authorization

UserSecurity

• Type: HTTP basic authentication