0.2.0 • Published 7 years ago

fn_js v0.2.0

Weekly downloads
3
License
Unlicense
Repository
-
Last release
7 years ago

fn_js

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

  • API version: 0.2.0
  • Package version: 0.2.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 fn_js --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 fn_js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('fn_js') 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/fn_js then install it via:

    npm install YOUR_USERNAME/fn_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, 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 FnJs = require('fn_js');

var api = new FnJs.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
FnJs.AppsApiappsAppDeleteDELETE /apps/{app}Delete an app.
FnJs.AppsApiappsAppGetGET /apps/{app}Get information for a app.
FnJs.AppsApiappsAppPatchPATCH /apps/{app}Updates an app.
FnJs.AppsApiappsGetGET /appsGet all app names.
FnJs.AppsApiappsPostPOST /appsPost new app
FnJs.CallApiappsAppCallsCallGetGET /apps/{app}/calls/{call}Get call information
FnJs.CallApiappsAppCallsCallLogDeleteDELETE /apps/{app}/calls/{call}/logDelete call log entry
FnJs.CallApiappsAppCallsCallLogGetGET /apps/{app}/calls/{call}/logGet call logs
FnJs.CallApiappsAppCallsGetGET /apps/{app}/callsGet app-bound calls.
FnJs.LogApiappsAppCallsCallLogDeleteDELETE /apps/{app}/calls/{call}/logDelete call log entry
FnJs.LogApiappsAppCallsCallLogGetGET /apps/{app}/calls/{call}/logGet call logs
FnJs.RoutesApiappsAppRoutesGetGET /apps/{app}/routesGet route list by app name.
FnJs.RoutesApiappsAppRoutesPostPOST /apps/{app}/routesCreate new Route
FnJs.RoutesApiappsAppRoutesRouteDeleteDELETE /apps/{app}/routes/{route}Deletes the route
FnJs.RoutesApiappsAppRoutesRouteGetGET /apps/{app}/routes/{route}Gets route by name
FnJs.RoutesApiappsAppRoutesRoutePatchPATCH /apps/{app}/routes/{route}Update a Route, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values.
FnJs.RoutesApiappsAppRoutesRoutePutPUT /apps/{app}/routes/{route}Create a Route if it does not exist. Update if it does. Will also create app if it does not exist. Put does not skip validation of zero values

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.