mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
63 lines
2.6 KiB
Markdown
63 lines
2.6 KiB
Markdown
# Go API client for functions
|
|
|
|
The open source serverless platform.
|
|
|
|
## Overview
|
|
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 0.1.28
|
|
- Package version: 0.1.28
|
|
- Build package: class io.swagger.codegen.languages.GoClientCodegen
|
|
|
|
## Installation
|
|
Put the package under your project folder and add the following in import:
|
|
```
|
|
"./functions"
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://127.0.0.1:8080/v1*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*AppsApi* | [**AppsAppDelete**](docs/AppsApi.md#appsappdelete) | **Delete** /apps/{app} | Delete an app.
|
|
*AppsApi* | [**AppsAppGet**](docs/AppsApi.md#appsappget) | **Get** /apps/{app} | Get information for a app.
|
|
*AppsApi* | [**AppsAppPatch**](docs/AppsApi.md#appsapppatch) | **Patch** /apps/{app} | Updates an app.
|
|
*AppsApi* | [**AppsGet**](docs/AppsApi.md#appsget) | **Get** /apps | Get all app names.
|
|
*AppsApi* | [**AppsPost**](docs/AppsApi.md#appspost) | **Post** /apps | Post new app
|
|
*RoutesApi* | [**AppsAppRoutesGet**](docs/RoutesApi.md#appsapproutesget) | **Get** /apps/{app}/routes | Get route list by app name.
|
|
*RoutesApi* | [**AppsAppRoutesPost**](docs/RoutesApi.md#appsapproutespost) | **Post** /apps/{app}/routes | Create new Route
|
|
*RoutesApi* | [**AppsAppRoutesRouteDelete**](docs/RoutesApi.md#appsapproutesroutedelete) | **Delete** /apps/{app}/routes/{route} | Deletes the route
|
|
*RoutesApi* | [**AppsAppRoutesRouteGet**](docs/RoutesApi.md#appsapproutesrouteget) | **Get** /apps/{app}/routes/{route} | Gets route by name
|
|
*RoutesApi* | [**AppsAppRoutesRoutePatch**](docs/RoutesApi.md#appsapproutesroutepatch) | **Patch** /apps/{app}/routes/{route} | Update a Route
|
|
*TasksApi* | [**TasksGet**](docs/TasksApi.md#tasksget) | **Get** /tasks | Get next task.
|
|
*VersionApi* | [**VersionGet**](docs/VersionApi.md#versionget) | **Get** /version | Get daemon version.
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [App](docs/App.md)
|
|
- [AppWrapper](docs/AppWrapper.md)
|
|
- [AppsWrapper](docs/AppsWrapper.md)
|
|
- [ErrorBody](docs/ErrorBody.md)
|
|
- [ModelError](docs/ModelError.md)
|
|
- [NewTask](docs/NewTask.md)
|
|
- [Route](docs/Route.md)
|
|
- [RouteWrapper](docs/RouteWrapper.md)
|
|
- [RoutesWrapper](docs/RoutesWrapper.md)
|
|
- [Task](docs/Task.md)
|
|
- [TaskWrapper](docs/TaskWrapper.md)
|
|
- [Version](docs/Version.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
All endpoints do not require authorization.
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|