1.0.1 • Published 8 years ago

haku v1.0.1

Weekly downloads
6
License
-
Repository
-
Last release
8 years ago

haku

Haku - JavaScript client for haku Concur Services Registry APIs This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-04-26T21:58:29.065Z
  • 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 haku --save

git

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

npm install YOUR_USERNAME/haku --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 Haku = require('haku');

var api = new Haku.DefaultApi()

var opts = { 
  'body': new Haku.ConfigMetadata() // {ConfigMetadata} 
};

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

Documentation for API Endpoints

All URIs are relative to http://localhost/v1

ClassMethodHTTP requestDescription
Haku.DefaultApiaddConfigPOST /configsadd config
Haku.DefaultApigetConfigDetailsGET /configs/{name}Returns a specific configuration
Haku.DefaultApigetConfigsGET /configsReturns all configs store
Haku.DefaultApigetConfiguratinsOptionsOPTIONS /configsReturns resource options
Haku.DefaultApigetSwaggerGET /api-docs
Haku.DefaultApiremoveConfigDELETE /configs/{name}Delete config
Haku.DefaultApiupdateConfigPUT /configsupdate config
Haku.ServicesApiaddServicePOST /servicesadd service
Haku.ServicesApigetServiceDetailsGET /services/{name}Returns a service's metadata
Haku.ServicesApigetServicesGET /servicesReturns all services deployed
Haku.ServicesApigetServicesOptionsOPTIONS /servicesReturns resource options
Haku.ServicesApiremoveServiceDELETE /services/{name}Delete service
Haku.ServicesApiupdateServicePUT /servicesupdate service

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.