csp_servorch_rest_api v1.0.0

csp_servorch_rest_api

CspServorchRestApi - JavaScript client for csp_servorch_rest_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 csp_servorch_rest_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your csp_servorch_rest_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('csp_servorch_rest_api') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/csp_servorch_rest_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, that's to say your javascript file where you actually use this library):

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 CspServorchRestApi = require('csp_servorch_rest_api');

var api = new CspServorchRestApi.DefaultApi()

var service = "service_example"; // {String} 

var name = "name_example"; // {String} 

var schemaVersion = "schemaVersion_example"; // {String} 

var dataVersion = "dataVersion_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.configDelete(service, name, schemaVersion, dataVersion, callback);

Documentation for API Endpoints

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

Documentation for Models

• CspServorchRestApi.ConfigMenu
• CspServorchRestApi.DataSchema
• CspServorchRestApi.HeartbeatInfo
• CspServorchRestApi.InlineResponse200
• CspServorchRestApi.InlineResponse2001
• CspServorchRestApi.Instance
• CspServorchRestApi.ServiceSchema
• CspServorchRestApi.Topology
• CspServorchRestApi.TopologyConfigMenu
• CspServorchRestApi.TopologyInstance

Documentation for Authorization

All endpoints do not require authorization.