api

package

v0.0.3 Latest Latest Go to latest Published: Oct 9, 2020 License: AGPL-3.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/weaklayer/gateway

Links

Open Source Insights

Documentation ¶

Index ¶

type EventsAPI
- func NewEventsAPI(tokenProcessor token.Processor, eventOutput output.Output) (EventsAPI, error)
- func (eventsAPI EventsAPI) Handle(responseWriter http.ResponseWriter, request *http.Request)
type InstallAPI
- func NewInstallAPI(tokenProcessor token.Processor, eventOutput output.Output, ...) (InstallAPI, error)
- func (installAPI InstallAPI) Handle(responseWriter http.ResponseWriter, request *http.Request)
type InstallRequest
type InstallResponse
type SensorAPI
- func (sensorAPI SensorAPI) ServeHTTP(responseWriter http.ResponseWriter, request *http.Request)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EventsAPI ¶

type EventsAPI struct {
	// contains filtered or unexported fields
}

EventsAPI handles requests to the /events path

func NewEventsAPI ¶

func NewEventsAPI(tokenProcessor token.Processor, eventOutput output.Output) (EventsAPI, error)

NewEventsAPI provisions an events API with its required resources

func (EventsAPI) Handle ¶

func (eventsAPI EventsAPI) Handle(responseWriter http.ResponseWriter, request *http.Request)

Handle does nothing right now

type InstallAPI ¶

type InstallAPI struct {
	// contains filtered or unexported fields
}

InstallAPI handles requests to the /install path for sensor installation

func NewInstallAPI ¶

func NewInstallAPI(tokenProcessor token.Processor, eventOutput output.Output, verifiers []auth.Verifier) (InstallAPI, error)

NewInstallAPI provisions a sensor API with its required resources

func (InstallAPI) Handle ¶

func (installAPI InstallAPI) Handle(responseWriter http.ResponseWriter, request *http.Request)

Handle validates and processes install requests

type InstallRequest ¶

type InstallRequest struct {
	Key   auth.Key `json:"key"`
	Label string   `json:"label"`
}

InstallRequest is what the sensor sends in the HTTP body to request installation

type InstallResponse ¶

type InstallResponse struct {
	Token     string    `json:"token"`
	Sensor    uuid.UUID `json:"sensor"`
	ExpiresAt int64     `json:"expiresAt"`
	IssuedAt  int64     `json:"issuedAt"`
}

InstallResponse forms the response body that the sensor will receive on a successful install request

type SensorAPI ¶

type SensorAPI struct {
	InstallHandler InstallAPI
	EventsHandler  EventsAPI
}

SensorAPI is the root HTTP Handler for the sensor API

func (SensorAPI) ServeHTTP ¶

func (sensorAPI SensorAPI) ServeHTTP(responseWriter http.ResponseWriter, request *http.Request)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL