fn_ruby
Fn - the Ruby gem for the fn
The open source serverless platform.
This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.2.1
- Package version: 0.2.1
- 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.2.1.gem
(for development, run gem install --dev ./fn_ruby-0.2.1.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.2.1'
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::CallApi | apps_app_calls_call_get | GET /apps/app/calls/call | Get call information |
| Fn::CallApi | apps_app_calls_call_log_delete | DELETE /apps/app/calls/call/log | Delete call log entry |
| Fn::CallApi | apps_app_calls_call_log_get | GET /apps/app/calls/call/log | Get call logs |
| Fn::CallApi | apps_app_calls_get | GET /apps/app/calls | Get app-bound calls. |
| Fn::LogApi | apps_app_calls_call_log_delete | DELETE /apps/app/calls/call/log | Delete call log entry |
| Fn::LogApi | apps_app_calls_call_log_get | GET /apps/app/calls/call/log | Get call logs |
| 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, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values. |
| Fn::RoutesApi | apps_app_routes_route_put | PUT /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
- Fn::App
- Fn::AppWrapper
- Fn::AppsWrapper
- Fn::Call
- Fn::CallWrapper
- Fn::CallsWrapper
- Fn::Error
- Fn::ErrorBody
- Fn::Log
- Fn::LogWrapper
- Fn::Route
- Fn::RouteWrapper
- Fn::RoutesWrapper
- Fn::Version
Documentation for Authorization
All endpoints do not require authorization.