fn_ruby

Fn - the Ruby gem for the IronFunctions

The open source serverless platform.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.29
• Package version: 0.1.31
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build fn_ruby.gemspec

Then either install the gem locally:

gem install ./fn_ruby-0.1.31.gem

(for development, run gem install --dev ./fn_ruby-0.1.31.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'fn_ruby', '~> 0.1.31'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'fn_ruby', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'fn_ruby'

api_instance = Fn::AppsApi.new

app = "app_example" # String | Name of the app.


begin
  #Delete an app.
  api_instance.apps_app_delete(app)
rescue Fn::ApiError => e
  puts "Exception when calling AppsApi->apps_app_delete: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Fn::AppsApi	apps_app_delete	DELETE /apps/app	Delete an app.
Fn::AppsApi	apps_app_get	GET /apps/app	Get information for a app.
Fn::AppsApi	apps_app_patch	PATCH /apps/app	Updates an app.
Fn::AppsApi	apps_get	GET /apps	Get all app names.
Fn::AppsApi	apps_post	POST /apps	Post new app
Fn::RoutesApi	apps_app_routes_get	GET /apps/app/routes	Get route list by app name.
Fn::RoutesApi	apps_app_routes_post	POST /apps/app/routes	Create new Route
Fn::RoutesApi	apps_app_routes_route_delete	DELETE /apps/app/routes/route	Deletes the route
Fn::RoutesApi	apps_app_routes_route_get	GET /apps/app/routes/route	Gets route by name
Fn::RoutesApi	apps_app_routes_route_patch	PATCH /apps/app/routes/route	Update a Route
Fn::TasksApi	tasks_get	GET /tasks	Get next task.
Fn::VersionApi	version_get	GET /version	Get daemon version.

Documentation for Models

• Fn::App
• Fn::AppWrapper
• Fn::AppsWrapper
• Fn::Error
• Fn::ErrorBody
• Fn::NewTask
• Fn::Route
• Fn::RouteWrapper
• Fn::RoutesWrapper
• Fn::TaskWrapper
• Fn::Version
• Fn::Task

Documentation for Authorization

All endpoints do not require authorization.