http

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• Constants
• func AllowHeaderOptionsGenerator(methods []string) rest.HandlerFunc
• func AutogenOptionsRoutes(routes []*rest.Route, gen HttpOptionsGenerator) []*rest.Route
• type ApiHandler
  • func NewInventoryApiHandlers(i inventory.InventoryApp) ApiHandler
• type HttpOptionsGenerator
• type InventoryApiGroup
  • func (g InventoryApiGroup) Validate() error

Constants

const (
	DefaultTimeout = time.Second * 10
)

Functions

func AllowHeaderOptionsGenerator

func AllowHeaderOptionsGenerator(methods []string) rest.HandlerFunc

func AutogenOptionsRoutes

func AutogenOptionsRoutes(routes []*rest.Route, gen HttpOptionsGenerator) []*rest.Route

Automatically add OPTIONS method support for each defined route, only if there's no OPTIONS handler for that route yet

Types

type ApiHandler

type ApiHandler interface {
	// produce a rest.App with routing setup or an error
	Build() (http.Handler, error)
}

thin API handler interface

func NewInventoryApiHandlers

func NewInventoryApiHandlers(i inventory.InventoryApp) ApiHandler

return an ApiHandler for device admission app

type HttpOptionsGenerator

type HttpOptionsGenerator func(methods []string) rest.HandlerFunc

type InventoryApiGroup

type InventoryApiGroup struct {
	Group model.GroupName `json:"group"`
}

model of device's group name response at /devices/:id/group endpoint

func (InventoryApiGroup) Validate

func (g InventoryApiGroup) Validate() error