serve

Documentation

Index

• func Run(apiConfig config.Config, frontend bool, port int) (err error)
• type DeleteRequest
• type DeleteResponse
• type DiffRequest
• type Response
• type ResponseError
• type TableList

Functions

func Run

func Run(apiConfig config.Config, frontend bool, port int) (err error)

Run Start the REST API Server

Types

type DeleteRequest

type DeleteRequest struct {
	Table string
}

type DeleteResponse

type DeleteResponse struct {
	Details string
}

type DiffRequest

type DiffRequest struct {
	Table string
}

type Response

type Response struct {
	Result interface{}   `json:"result"`
	Error  ResponseError `json:"error"`
}

Response Standardised response helper struct

type ResponseError

type ResponseError struct {
	Error  string      `json:"error"`
	Detail string      `json:"detail"`
	Data   interface{} `json:"data"`
}

ResponseError Standardised response error helper struct

type TableList

type TableList struct {
	Tables []table.Table `json:"tables"`
	Start  int64         `json:"start"`
	End    int64         `json:"end"`
	Total  int64         `json:"total"`
}

TableList Helper type used to return a List of Tables