...

Package interlock

import "edge-infra.dev/pkg/sds/interlock"
Overview
Index
Subdirectories

Overview ▾

Package classification Interlock

Documentation for the Interlock API

Schemes: http
BasePath: /
Version: 1.0.0
Host: interlock.interlock.svc.cluster.local

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Constants

const (
    InterlockAPIPort        = 80
    InterlockMetricsAPIPort = 8080
)

func Run

func Run() error

Run the Interlock webserver and start the Interlock API and Interlock metrics API

type EndpointRegistrant

EndpointRegistrant is an interface for package to register endpoints to a router

type EndpointRegistrant interface {
    RegisterEndpoints(*gin.Engine)
}

type ErrorResponseWrapper

The request has failed

swagger:response ErrorResponse

type ErrorResponseWrapper struct {
    // Descriptions of the errors that occurred
    //
    // in: body
    Body Errors `json:"body"`
}

type Errors

Errors returned on API failures

type Errors struct {
    Errors []errs.Error `json:"errors"`
}

Subdirectories