iron_functions
IronFunctions - 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.28
- Package version: 0.1.28
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build iron_functions.gemspec
Then either install the gem locally:
gem install ./iron_functions-0.1.28.gem
(for development, run gem install --dev ./iron_functions-0.1.28.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 'iron_functions', '~> 0.1.28'
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 'iron_functions', :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 'iron_functions'
api_instance = IronFunctions::AppsApi.new
app = "app_example" # String | Name of the app.
begin
#Delete an app.
api_instance.apps_app_delete(app)
rescue IronFunctions::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 |
---|---|---|---|
IronFunctions::AppsApi | apps_app_delete | DELETE /apps/{app} | Delete an app. |
IronFunctions::AppsApi | apps_app_get | GET /apps/{app} | Get information for a app. |
IronFunctions::AppsApi | apps_app_patch | PATCH /apps/{app} | Updates an app. |
IronFunctions::AppsApi | apps_get | GET /apps | Get all app names. |
IronFunctions::AppsApi | apps_post | POST /apps | Post new app |
IronFunctions::RoutesApi | apps_app_routes_get | GET /apps/{app}/routes | Get route list by app name. |
IronFunctions::RoutesApi | apps_app_routes_post | POST /apps/{app}/routes | Create new Route |
IronFunctions::RoutesApi | apps_app_routes_route_delete | DELETE /apps/{app}/routes/{route} | Deletes the route |
IronFunctions::RoutesApi | apps_app_routes_route_get | GET /apps/{app}/routes/{route} | Gets route by name |
IronFunctions::RoutesApi | apps_app_routes_route_patch | PATCH /apps/{app}/routes/{route} | Update a Route |
IronFunctions::TasksApi | tasks_get | GET /tasks | Get next task. |
IronFunctions::VersionApi | version_get | 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.