Skip to content

README.md

Latest commit

 

History

History
156 lines (108 loc) · 4.89 KB

README.md

File metadata and controls

156 lines (108 loc) · 4.89 KB
Raw

swagger-java-client

fn

  • API version: 2.0.0
    • Build date: 2019-03-27T15:47:31.669Z

The open source serverless platform.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppsApi;

import java.io.File;
import java.util.*;

public class AppsApiExample {

    public static void main(String[] args) {
        
        AppsApi apiInstance = new AppsApi();
        App body = new App(); // App | Application data to insert.
        try {
            App result = apiInstance.createApp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppsApi#createApp");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AppsApi createApp POST /apps Create A New Application
AppsApi deleteApp DELETE /apps/{appID} Delete An Application
AppsApi getApp GET /apps/{appID} Get Information For An Application
AppsApi listApps GET /apps Get A List Of Applications
AppsApi updateApp PUT /apps/{appID} Update an Application
CallApi fnsFnIDCallsCallIDGet GET /fns/{fnID}/calls/{callID} Get call information
CallApi fnsFnIDCallsGet GET /fns/{fnID}/calls Get a fns calls.
CallApi getCallLogs GET /fns/{fnID}/calls/{callID}/log Get logs for a call.
FnsApi createFn POST /fns Create A New Function
FnsApi deleteFn DELETE /fns/{fnID} Delete A Function
FnsApi getFn GET /fns/{fnID} Get Definition Of A Function
FnsApi listFns GET /fns Get A list Of Functions Within An Application
FnsApi updateFn PUT /fns/{fnID} Update A Function
LogApi getCallLogs GET /fns/{fnID}/calls/{callID}/log Get logs for a call.
TriggersApi createTrigger POST /triggers Create A New Trigger.
TriggersApi deleteTrigger DELETE /triggers/{triggerID} Delete A Trigger
TriggersApi getTrigger GET /triggers/{triggerID} Get Definition Of A Trigger
TriggersApi listTriggers GET /triggers Get A List Of Triggers Within An Application Or Function
TriggersApi updateTrigger PUT /triggers/{triggerID} Update A Trigger

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author