api

README

API server information

API path	Description
/	Redirects to the /UI path (and the web based user interface)
/config/get	Gets a single configuration item
/config/set	Sets (creates or updates) a configuration item
/config/remove	Removes a configuration item
/config/getall	Gets all configuration items
/config/getallforapp	Get all configuration items for a single application (plus the default * application)
/applications/getall	Get all applications

######Requests Most API operations expect a configitem object in the POST body that will be used to either filter (in a get operation), update or create (in a set operation), or remove an item (in a remove operation).

For example:

{
    "application" : "WickedCool",
    "name": "TestItem42",
    "value": "Magic!"
}

######Responses All operations will return an object that contain the fields status, message, and data.

For Example:

{
  "status": 200,
  "message": "Config items found",
  "data": [
    {
      "id": 1,
      "application": "*",
      "machine": "",
      "name": "Environment",
      "value": "DEV",
      "updated": "2016-04-26T09:11:17.897Z"
    },
    {
      "id": 2,
      "application": "TestApp",
      "machine": "",
      "name": "AppUser",
      "value": "TestApp_dev",
      "updated": "2016-04-26T09:11:40.34Z"
    }
  ]
}

/config/get

This operation retrieves a single configuration item

Example request:

{
  "name": "test"
}

Documentation

Index

• Variables
• func GetAllApplications(rw http.ResponseWriter, req *http.Request)
• func GetAllConfig(rw http.ResponseWriter, req *http.Request)
• func GetAllConfigForApp(rw http.ResponseWriter, req *http.Request)
• func GetConfig(rw http.ResponseWriter, req *http.Request)
• func InitStore(rw http.ResponseWriter, req *http.Request)
• func RemoveConfig(rw http.ResponseWriter, req *http.Request)
• func SetConfig(rw http.ResponseWriter, req *http.Request)
• func ShowUI(rw http.ResponseWriter, req *http.Request)
• type Hub
  • func NewHub() *Hub
• type WsHandler
  • func (wsh WsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var (
	WsHub = NewHub()
)

Functions

func GetAllApplications

func GetAllApplications(rw http.ResponseWriter, req *http.Request)

Gets all applications

func GetAllConfig

func GetAllConfig(rw http.ResponseWriter, req *http.Request)

Gets all config information

func GetAllConfigForApp

func GetAllConfigForApp(rw http.ResponseWriter, req *http.Request)

Gets all config information for a given application

func GetConfig

func GetConfig(rw http.ResponseWriter, req *http.Request)

Gets a specfic config item based on application and config item name

func InitStore

func InitStore(rw http.ResponseWriter, req *http.Request)

Initializes a store

func RemoveConfig

func RemoveConfig(rw http.ResponseWriter, req *http.Request)

Removes a specific config item

func SetConfig

func SetConfig(rw http.ResponseWriter, req *http.Request)

Set a specific config item

func ShowUI

func ShowUI(rw http.ResponseWriter, req *http.Request)

Types

type Hub

type Hub struct {

	// Inbound messages from the connections.
	Broadcast chan []byte
	// contains filtered or unexported fields
}

func NewHub

func NewHub() *Hub

type WsHandler

type WsHandler struct {
	H *Hub
}

func (WsHandler) ServeHTTP

func (wsh WsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)