Feature/api

README.md

@@ -32,6 +32,7 @@
   * [x] RPM curve
   * [x] minimum and maximum PWM
 * [x] Error notifications
+* [x] (optional) REST Api
 
 # How to use
 
@@ -456,6 +457,48 @@ statistics:
 You can then see the metics on [http://localhost:9000/metrics](http://localhost:9000/metrics) while the fan2go daemon is
 running.
 
+## API
+
+fan2go comes with a built-in REST Api. This API can be used by third party tools to display (and in the future possibly
+modify) the state of fans, sensors and curves within fan2go.
+
+```yaml
+api:
+  # Whether to enable the API or not
+  enabled: false
+  # The host to listen for connections
+  host: localhost
+  # The port to listen for connections
+  port: 9001
+```
+
+### Endpoints
+
+Currently, this API is read-only and only provides REST endpoints. If there is demand for it, this might be expanded to
+also support realtime
+communication via websockets.
+
+#### Fans
+
+| Endpoint    | Type | Description                                       |
+|-------------|------|---------------------------------------------------|
+| `/fan`      | GET  | Returns a list of all currently configured fans   |
+| `/fan/<id>` | GET  | Returns the fan with the given <id>, if it exists |
+
+#### Sensors
+
+| Endpoint    | Type | Description                                          |
+|-------------|------|------------------------------------------------------|
+| `/fan`      | GET  | Returns a list of all currently configured sensors   |
+| `/fan/<id>` | GET  | Returns the sensor with the given <id>, if it exists |
+
+#### Curves
+
+| Endpoint      | Type | Description                                         |
+|---------------|------|-----------------------------------------------------|
+| `/curve`      | GET  | Returns a list of all currently configured curves   |
+| `/curve/<id>` | GET  | Returns the curve with the given <id>, if it exists |
+
 # How it works
 
 ## Device detection

fan2go.yaml

@@ -126,4 +126,12 @@ statistics:
   # Whether to enable the prometheus exporter or not
   enabled: false
   # The port to expose the exporter on
-  port: 9000
+  port: 9000
+
+api:
+  # Whether to enable the API or not
+  enabled: false
+  # The host to listen for connections
+  host: localhost
+  # The port to listen for connections
+  port: 9001

go.mod

@@ -4,7 +4,9 @@ go 1.18
 
 require (
 	github.com/asecurityteam/rolling v2.0.4+incompatible
+	github.com/gorilla/websocket v1.5.0
 	github.com/guptarohit/asciigraph v0.5.5
+	github.com/labstack/echo/v4 v4.7.2
 	github.com/looplab/tarjan v0.1.0
 	github.com/md14454/gosensors v0.0.0-20180726083412-bded752ab001
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d
@@ -26,10 +28,12 @@ require (
 	github.com/cespare/xxhash/v2 v2.1.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/gookit/color v1.5.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/labstack/gommon v0.3.1 // indirect
 	github.com/magiconair/properties v1.8.6 // indirect
 	github.com/mattn/go-colorable v0.1.12 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
@@ -48,10 +52,15 @@ require (
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.2.0 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasttemplate v1.2.1 // indirect
 	github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 // indirect
+	golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 // indirect
+	golang.org/x/net v0.0.0-20220412020605-290c469a71a5 // indirect
 	golang.org/x/sys v0.0.0-20220412211240-33da011f77ad // indirect
 	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
 	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
 	google.golang.org/protobuf v1.28.0 // indirect
 	gopkg.in/ini.v1 v1.66.4 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -93,6 +93,8 @@ github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V
 github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
+github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
+github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
 github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
@@ -156,6 +158,8 @@ github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8
 github.com/gookit/color v1.4.2/go.mod h1:fqRyamkC1W8uxl+lxCQxOT09l/vYfZ+QeiX3rKQHCoQ=
 github.com/gookit/color v1.5.0 h1:1Opow3+BWDwqor78DcJkJCIwnkviFi+rrOANki9BUFw=
 github.com/gookit/color v1.5.0/go.mod h1:43aQb+Zerm/BWh2GnrgOQm7ffz7tvQXEKV6BFMl7wAo=
+github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
+github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/guptarohit/asciigraph v0.5.5 h1:ccFnUF8xYIOUPPY3tmdvRyHqmn1MYI9iv1pLKX+/ZkQ=
 github.com/guptarohit/asciigraph v0.5.5/go.mod h1:dYl5wwK4gNsnFf9Zp+l06rFiDZ5YtXM6x7SRWZ3KGag=
 github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
@@ -189,11 +193,16 @@ github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORN
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/labstack/echo/v4 v4.7.2 h1:Kv2/p8OaQ+M6Ex4eGimg9b9e6icoxA42JSlOR3msKtI=
+github.com/labstack/echo/v4 v4.7.2/go.mod h1:xkCDAdFCIf8jsFQ5NnbK7oqaF/yU1A1X20Ltm0OvSks=
+github.com/labstack/gommon v0.3.1 h1:OomWaJXm7xR6L1HmEtGyQf26TEn7V6X88mktX9kee9o=
+github.com/labstack/gommon v0.3.1/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM=
 github.com/looplab/tarjan v0.1.0 h1:LycVSLuqFNb6S/RKau7inixXD0K45fTlZ0Zy9WTtwzw=
 github.com/looplab/tarjan v0.1.0/go.mod h1:3CvPAapzS1ESsE1ql7MXbad+ENQS21SsfatXQpXFqEo=
 github.com/magiconair/properties v1.8.6 h1:5ibWZ6iY0NctNGWo87LalDlEZ6R41TqbbDamhfG/Qzo=
 github.com/magiconair/properties v1.8.6/go.mod h1:y3VJvCyxH9uVvJTWEGAELF3aiYNyPKd5NZ3oSwXrF60=
 github.com/mattn/go-colorable v0.1.7/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
 github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
@@ -296,6 +305,10 @@ github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/tomlazar/table v0.1.2 h1:DP8f62FzZAZk8oavepm1v/oyf4ni3/LMHWNlOinmleg=
 github.com/tomlazar/table v0.1.2/go.mod h1:IecZnpep9f/BatHacfh+++ftE+lFONN8BVPi9nx5U1w=
+github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
+github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
+github.com/valyala/fasttemplate v1.2.1 h1:TVEnxayobAdVkhQfrfes2IzOB6o+z4roRkPF52WA1u4=
+github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ=
 github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 h1:QldyIu/L63oPpyvQmHgvgickp1Yw510KJOqX7H24mg8=
 github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778/go.mod h1:2MuV+tbUrU1zIOPMxZ5EncGwgmMJsa+9ucAQZXxsObs=
 github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
@@ -318,6 +331,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
 golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 h1:kUhD7nTDoI3fVd9G4ORWrbV5NY0liEs/Jg2pv5f+bBA=
+golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
@@ -387,6 +402,8 @@ golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220412020605-290c469a71a5 h1:bRb386wvrE+oBNdF1d/Xh9mQrfQ4ecYhW5qJ5GvTGT4=
+golang.org/x/net v0.0.0-20220412020605-290c469a71a5/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -456,6 +473,7 @@ golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211013075003-97ac67df715c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220412211240-33da011f77ad h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
@@ -477,6 +495,8 @@ golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
+golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 h1:Hir2P/De0WpUhtrKGGjvSb2YxUgyZ7EFOSLIcSSpiwE=
+golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=

internal/api/curves.go

@@ -0,0 +1,40 @@
+package api
+
+import (
+	"errors"
+	"github.com/labstack/echo/v4"
+	"github.com/markusressel/fan2go/internal/curves"
+	"net/http"
+)
+
+func registerCurveEndpoints(rest *echo.Echo) {
+	group := rest.Group("/curve")
+
+	group.GET("/", getCurves)
+	group.GET("/:"+urlParamId+"/", getCurve)
+	group.POST("/", createCurve)
+	group.DELETE("/:"+urlParamId+"/", deleteCurve)
+}
+
+func getCurves(c echo.Context) error {
+	data := curves.SpeedCurveMap
+	return c.JSONPretty(http.StatusOK, data, indentationChar)
+}
+
+func getCurve(c echo.Context) error {
+	id := c.Param(urlParamId)
+	data, exists := curves.SpeedCurveMap[id]
+	if !exists {
+		return returnNotFound(c, id)
+	} else {
+		return c.JSONPretty(http.StatusOK, data, indentationChar)
+	}
+}
+
+func deleteCurve(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}
+
+func createCurve(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}

internal/api/fans.go

@@ -0,0 +1,41 @@
+package api
+
+import (
+	"errors"
+	"github.com/labstack/echo/v4"
+	"github.com/markusressel/fan2go/internal/fans"
+	"net/http"
+)
+
+func registerFanEndpoints(rest *echo.Echo) {
+	group := rest.Group("/fan")
+
+	group.GET("/", getFans)
+	group.GET("/:"+urlParamId+"/", getFan)
+	group.POST("/", createFan)
+	group.DELETE("/:"+urlParamId+"/", deleteFan)
+}
+
+// returns a list of all currently configured fans
+func getFans(c echo.Context) error {
+	data := fans.FanMap
+	return c.JSONPretty(http.StatusOK, data, indentationChar)
+}
+
+func getFan(c echo.Context) error {
+	id := c.Param(urlParamId)
+	data, exists := fans.FanMap[id]
+	if !exists {
+		return returnNotFound(c, id)
+	} else {
+		return c.JSONPretty(http.StatusOK, data, indentationChar)
+	}
+}
+
+func deleteFan(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}
+
+func createFan(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}

internal/api/rest.go

@@ -0,0 +1,64 @@
+package api
+
+import (
+	"github.com/labstack/echo/v4"
+	"github.com/labstack/echo/v4/middleware"
+	"net/http"
+)
+
+const (
+	urlParamId      = "id"
+	indentationChar = "  "
+)
+
+type (
+	Result struct {
+		Name    string `json:"name"`
+		Message string `json:"message"`
+	}
+)
+
+func CreateRestService() *echo.Echo {
+	echoRest := echo.New()
+	echoRest.HideBanner = true
+
+	// Root level middleware
+	echoRest.Pre(middleware.AddTrailingSlash())
+
+	echoRest.Use(middleware.Secure())
+
+	//echoRest.Use(middleware.Logger())
+	echoRest.Use(middleware.Recover())
+
+	echoRest.GET("/alive/", isAlive)
+
+	// Authentication
+	// Group level middleware
+	registerFanEndpoints(echoRest)
+	registerSensorEndpoints(echoRest)
+	registerCurveEndpoints(echoRest)
+	//registerWebsocketEndpoint(echoRest)
+
+	return echoRest
+}
+
+// returns an empty "ok" answer
+func isAlive(c echo.Context) error {
+	return c.NoContent(http.StatusOK)
+}
+
+// return a "not found" message
+func returnNotFound(c echo.Context, id string) (err error) {
+	return c.JSONPretty(http.StatusNotFound, &Result{
+		Name:    "Not found",
+		Message: "No item with id '" + id + "' found",
+	}, indentationChar)
+}
+
+// return the error message of an error
+func returnError(c echo.Context, e error) (err error) {
+	return c.JSONPretty(http.StatusInternalServerError, &Result{
+		Name:    "Unknown Error",
+		Message: e.Error(),
+	}, indentationChar)
+}

internal/api/sensors.go

@@ -0,0 +1,41 @@
+package api
+
+import (
+	"errors"
+	"github.com/labstack/echo/v4"
+	"github.com/markusressel/fan2go/internal/sensors"
+	"net/http"
+)
+
+func registerSensorEndpoints(rest *echo.Echo) {
+	group := rest.Group("/sensor")
+
+	group.GET("/", getSensors)
+	group.GET("/:"+urlParamId+"/", getSensor)
+	group.POST("/", createSensor)
+	group.DELETE("/:"+urlParamId+"/", deleteSensor)
+}
+
+func getSensors(c echo.Context) error {
+	data := sensors.SensorMap
+	return c.JSONPretty(http.StatusOK, data, indentationChar)
+}
+
+func getSensor(c echo.Context) error {
+	id := c.Param(urlParamId)
+
+	data, exists := sensors.SensorMap[id]
+	if !exists {
+		return returnNotFound(c, id)
+	} else {
+		return c.JSONPretty(http.StatusOK, data, indentationChar)
+	}
+}
+
+func createSensor(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}
+
+func deleteSensor(c echo.Context) error {
+	return returnError(c, errors.New("not yet supported"))
+}