Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

REST

package

Go to main page

Versions in this module

v1

v1.0.0

Aug 2, 2024

v0

v0.5.1

Aug 2, 2024

Changes in this version

+ const DeviceAuthScopes

+ func GetSwagger() (swagger *openapi3.T, err error)

+ func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

+ func RegisterHandlers(router EchoRouter, si ServerInterface)

+ func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

+ type CreateModuleParams struct

+ XDeviceID XDeviceID

+ type DeleteModulesParams struct

+ DeviceId *DeviceIDQuery

+ XDeviceID XDeviceID

+ type Device struct

+ Id DeviceID

+ type DeviceID = openapi_types.UUID

+ type DeviceIDQuery = DeviceID

+ type DeviceList struct

+ Count ListItemCount

+ Items []Device

+ type DeviceListResponse = DeviceList

+ type EchoRouter interface

+ CONNECT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ DELETE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ GET func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ HEAD func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ OPTIONS func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PATCH func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ POST func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PUT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ TRACE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ type GetDevicesParams struct

+ XDeviceID XDeviceID

+ type GetModuleParams struct

+ DeviceId *DeviceIDQuery

+ XDeviceID XDeviceID

+ type HealthAggregation struct

+ Components *[]HealthAggregationComponent

+ Health HealthResult

+ type HealthAggregationComponent struct

+ Health HealthResult

+ Name string

+ type HealthResult string

+ const Down

+ const Up

+ type ListItemCount = int

+ type ModifiedAtTimestamp = time.Time

+ type ModuleDataAccepted = interface

+ type ModuleDataStream = openapi_types.File

+ type ModuleDeletionAccepted = interface

+ type ModuleName = string

+ type RegisterParams struct

+ Share *ShareCode

+ XDeviceID XDeviceID

+ type RegistrationResult struct

+ Password string

+ Username string

+ type ServerInterface interface

+ CreateModule func(ctx echo.Context, name ModuleName, params CreateModuleParams) error

+ DeleteModules func(ctx echo.Context, params DeleteModulesParams) error

+ GetDevices func(ctx echo.Context, params GetDevicesParams) error

+ GetModule func(ctx echo.Context, name ModuleName, params GetModuleParams) error

+ IsHealthy func(ctx echo.Context) error

+ IsReady func(ctx echo.Context) error

+ Register func(ctx echo.Context, params RegisterParams) error

+ Share func(ctx echo.Context, params ShareParams) error

+ type ServerInterfaceWrapper struct

+ Handler ServerInterface

+ func (w *ServerInterfaceWrapper) CreateModule(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteModules(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetDevices(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetModule(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) IsHealthy(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) IsReady(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) Register(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) Share(ctx echo.Context) error

+ type ShareCode = string

+ type ShareParams struct

+ XDeviceID XDeviceID

+ type ShareResponse struct

+ ShareCode *string

+ type XDeviceID = DeviceID