functions_js
v0.0.1
Published
null
Downloads
3
Readme
functions_js
FunctionsJs - JavaScript client for functions_js null This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- Build date: 2016-10-14T03:47:49.281Z
- 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 functions_js --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/functions_js then install it via:
npm install YOUR_USERNAME/functions_js --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 FunctionsJs = require('functions_js');
var api = new FunctionsJs.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. Returned data: ' + data);
}
};
api.appsAppGet(app, callback);
Documentation for API Endpoints
All URIs are relative to https://127.0.0.1:8080/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- FunctionsJs.AppsApi | appsAppGet | GET /apps/{app} | Get information for a app. FunctionsJs.AppsApi | appsAppPut | PUT /apps/{app} | Create/update a app. FunctionsJs.AppsApi | appsGet | GET /apps | Get all app names. FunctionsJs.AppsApi | appsPost | POST /apps | Post new app FunctionsJs.RoutesApi | appsAppRoutesGet | GET /apps/{app}/routes | Get route list by app name. FunctionsJs.RoutesApi | appsAppRoutesPost | POST /apps/{app}/routes | Create new Route FunctionsJs.RoutesApi | appsAppRoutesRouteDelete | DELETE /apps/{app}/routes/{route} | Deletes the route FunctionsJs.RoutesApi | appsAppRoutesRouteGet | GET /apps/{app}/routes/{route} | Gets route by name FunctionsJs.TasksApi | tasksGet | GET /tasks | Get next task.
Documentation for Models
- FunctionsJs.App
- FunctionsJs.AppWrapper
- FunctionsJs.AppsWrapper
- FunctionsJs.Error
- FunctionsJs.ErrorBody
- FunctionsJs.NewTasksWrapper
- FunctionsJs.Route
- FunctionsJs.RouteWrapper
- FunctionsJs.RoutesWrapper
- FunctionsJs.Task
- FunctionsJs.TaskWrapper
- FunctionsJs.TasksWrapper
Documentation for Authorization
All endpoints do not require authorization.