iron_functions

December 19, 2016 ยท View on GitHub

IronFunctions - JavaScript client for iron_functions The open source serverless platform. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.28
  • Package version: 0.1.28
  • 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 iron_functions --save

git

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

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

var api = new IronFunctions.AppsApi()

var app = "app_example"; // {String} Name of the app.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.appsAppDelete(app, callback);

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8080/v1

ClassMethodHTTP requestDescription
IronFunctions.AppsApiappsAppDeleteDELETE /apps/{app}Delete an app.
IronFunctions.AppsApiappsAppGetGET /apps/{app}Get information for a app.
IronFunctions.AppsApiappsAppPatchPATCH /apps/{app}Updates an app.
IronFunctions.AppsApiappsGetGET /appsGet all app names.
IronFunctions.AppsApiappsPostPOST /appsPost new app
IronFunctions.RoutesApiappsAppRoutesGetGET /apps/{app}/routesGet route list by app name.
IronFunctions.RoutesApiappsAppRoutesPostPOST /apps/{app}/routesCreate new Route
IronFunctions.RoutesApiappsAppRoutesRouteDeleteDELETE /apps/{app}/routes/{route}Deletes the route
IronFunctions.RoutesApiappsAppRoutesRouteGetGET /apps/{app}/routes/{route}Gets route by name
IronFunctions.RoutesApiappsAppRoutesRoutePatchPATCH /apps/{app}/routes/{route}Update a Route
IronFunctions.TasksApitasksGetGET /tasksGet next task.
IronFunctions.VersionApiversionGetGET /versionGet daemon version.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.