iron_functions

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

Class	Method	HTTP request	Description
IronFunctions.AppsApi	appsAppDelete	DELETE /apps/{app}	Delete an app.
IronFunctions.AppsApi	appsAppGet	GET /apps/{app}	Get information for a app.
IronFunctions.AppsApi	appsAppPatch	PATCH /apps/{app}	Updates an app.
IronFunctions.AppsApi	appsGet	GET /apps	Get all app names.
IronFunctions.AppsApi	appsPost	POST /apps	Post new app
IronFunctions.RoutesApi	appsAppRoutesGet	GET /apps/{app}/routes	Get route list by app name.
IronFunctions.RoutesApi	appsAppRoutesPost	POST /apps/{app}/routes	Create new Route
IronFunctions.RoutesApi	appsAppRoutesRouteDelete	DELETE /apps/{app}/routes/{route}	Deletes the route
IronFunctions.RoutesApi	appsAppRoutesRouteGet	GET /apps/{app}/routes/{route}	Gets route by name
IronFunctions.RoutesApi	appsAppRoutesRoutePatch	PATCH /apps/{app}/routes/{route}	Update a Route
IronFunctions.TasksApi	tasksGet	GET /tasks	Get next task.
IronFunctions.VersionApi	versionGet	GET /version	Get daemon version.

Documentation for Models

• IronFunctions.App
• IronFunctions.AppWrapper
• IronFunctions.AppsWrapper
• IronFunctions.Error
• IronFunctions.ErrorBody
• IronFunctions.NewTask
• IronFunctions.Route
• IronFunctions.RouteWrapper
• IronFunctions.RoutesWrapper
• IronFunctions.Task
• IronFunctions.TaskWrapper
• IronFunctions.Version

Documentation for Authorization

All endpoints do not require authorization.