fn-serverless/vendor/github.com/funcy/functions_go/docs/RoutesApi.md

\RoutesApi

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

Method	HTTP request	Description
AppsAppRoutesGet	Get /apps/{app}/routes	Get route list by app name.
AppsAppRoutesPost	Post /apps/{app}/routes	Create new Route
AppsAppRoutesRouteDelete	Delete /apps/{app}/routes/{route}	Deletes the route
AppsAppRoutesRouteGet	Get /apps/{app}/routes/{route}	Gets route by name
AppsAppRoutesRoutePatch	Patch /apps/{app}/routes/{route}	Update a Route

AppsAppRoutesGet

RoutesWrapper AppsAppRoutesGet($app)

Get route list by app name.

This will list routes for a particular app.

Parameters

Name	Type	Description	Notes
app	string	Name of app for this set of routes.

Return type

RoutesWrapper

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AppsAppRoutesPost

RouteWrapper AppsAppRoutesPost($app, $body)

Create new Route

Create a new route in an app, if app doesn't exists, it creates the app

Parameters

Name	Type	Description	Notes
app	string	name of the app.
body	RouteWrapper	One route to post.

Return type

RouteWrapper

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AppsAppRoutesRouteDelete

AppsAppRoutesRouteDelete($app, $route)

Deletes the route

Deletes the route.

Parameters

Name	Type	Description	Notes
app	string	Name of app for this set of routes.
route	string	Route name

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AppsAppRoutesRouteGet

RouteWrapper AppsAppRoutesRouteGet($app, $route)

Gets route by name

Gets a route by name.

Parameters

Name	Type	Description	Notes
app	string	Name of app for this set of routes.
route	string	Route name

Return type

RouteWrapper

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AppsAppRoutesRoutePatch

RouteWrapper AppsAppRoutesRoutePatch($app, $route, $body)

Update a Route

Update a route

Parameters

Name	Type	Description	Notes
app	string	name of the app.
route	string	route path.
body	RouteWrapper	One route to post.

Return type

RouteWrapper

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]