vega_os_api v0.1.2

vega_os_api

VegaOsApi - JavaScript client for vega_os_api This is a Vega OS Api Reference. Content-Type is application/json All timestamps are returned in ISO 8601 format: * All key/value are optional unless noted otherwise. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.2
• Package version: 0.1.2
• Build date: 2016-08-29T00:53:12.448Z
• Build package: class 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 vega_os_api --save

git

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

    npm install YOUR_USERNAME/vega_os_api --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.

Getting Started

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

var VegaOsApi = require('vega_os_api');

var defaultClient = VegaOsApi.ApiClient.instance;

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

var api = new VegaOsApi.AppsApi()

var appName = "appName_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsAppNameGet(appName, callback);

Documentation for API Endpoints

All URIs are relative to http://218.108.7.113:8080/

Documentation for Models

• VegaOsApi.AppInfo
• VegaOsApi.Inband
• VegaOsApi.InterfaceConf
• VegaOsApi.IpAddr
• VegaOsApi.IpRoutes
• VegaOsApi.Qinq
• VegaOsApi.Sensors

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication