Help us shape the future of Go! Take the 2026 Go Developer Survey

routing

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2019 License: GPL-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ErrorInvalidPassword = "Invalid password" // Invalid password error
)

Variables

This section is empty.

Functions

func CreateChart

func CreateChart(env *utils.Env) httprouter.Handle

swagger:route POST /charts Charts CreateChart

Handler to create a chart

Creates a new chart Produces:

application/json

Responses:

200: ResourceStatusResponse

func CreateLogFile

func CreateLogFile(env *utils.Env) httprouter.Handle

Handler to create a new log file

This method will create a new log file in the database and create new physical files in the logs, notes directory.

Produces:

application/json

Consumes:

application/json

Responses:

default: ResourceStatusResponse

func CreateSheet

func CreateSheet(env *utils.Env) httprouter.Handle

swagger:route POST /sheets/ Sheets CreateSheet

Handler to create a new sheet object

This will add a new sheet to the database Only charts that exist can be added

Produces:

application/json

Responses:

200: ResourceStatusResponse

func CreateUser

func CreateUser(env *utils.Env) httprouter.Handle

swagger:route POST /users Users CreateUser

Handler to create a user

Creates a new user Produces:

application/json

Responses:

200: ResourceStatusResponse

func CreateWorkspace

func CreateWorkspace(env *utils.Env) httprouter.Handle

swagger:route POST /workspaces Workspaces CreateWorkspace

Handler to create a new workspace object

This will add a new workspace to the database Only sheets that exist can be added

Produces:

application/json

Responses:

200: ResourceStatusResponse

func DeleteChart

func DeleteChart(env *utils.Env) httprouter.Handle

swagger:route DELETE /charts/{uuid} Charts DeleteChart

Handler to delete a chart

Deletes a existing chart Produces:

application/json

Responses:

200: ResourceStatusResponse

func DeleteLogFile

func DeleteLogFile(env *utils.Env) httprouter.Handle

swagger:route DELETE /logFiles/{uuid} logFiles DeleteLogFile

Handler to delete the logFile name

This will delete a log file

Consumes:

application/json

Responses:

default: ResourceStatusResponse

func DeleteSheet

func DeleteSheet(env *utils.Env) httprouter.Handle

swagger:route DELETE /sheets/{uuid} Sheets DeleteSheet

Handler to delete a existing sheet object

This will add delete a sheet from the database

Produces:

application/json

Responses:

200: ResourceStatusResponse

func DeleteUser

func DeleteUser(env *utils.Env) httprouter.Handle

swagger:route DELETE /users/{uuid} Users DeleteUser

Handler to delete a user

Deletes a existing user Produces:

application/json

Responses:

200: ResourceStatusResponse

func DeleteWorkspace

func DeleteWorkspace(env *utils.Env) httprouter.Handle

swagger:route DELETE /workspaces/{uuid} Workspaces DeleteWorkspace

Handler to delete a existing workspace object

This will add delete a workspace from the database

Produces:

application/json

Responses:

200: ResourceStatusResponse

func GetAllCharts

func GetAllCharts(env *utils.Env) httprouter.Handle

swagger:route GET /charts/ Charts GetAllCharts

Handler to retrieve all available charts

Returns all charts

Produces:

application/json

Responses:

200: body:[]Chart

func GetAllLogFiles

func GetAllLogFiles(env *utils.Env) httprouter.Handle

swagger:route GET /logFiles logFiles GetAllLogFiles

Handler to retrieve all logFiles

This will return all available logs

Produces:

application/json

Responses:

200: []LogFileResponse

func GetAllSheets

func GetAllSheets(env *utils.Env) httprouter.Handle

swagger:route GET /sheets Sheets GetAllSheets

Handler to retrieve all sheets

This will return all available sheets

Produces:

application/json

Responses:

200: body:[]SheetResponse

func GetAllWorkspaces

func GetAllWorkspaces(env *utils.Env) httprouter.Handle

swagger:route GET /workspaces Workspaces GetAllWorkspaces

Handler to retrieve all workspaces

This will return all available workspaces

Produces:

application/json

Responses:

200: body:[]WorkspaceResponse

func GetChart

func GetChart(env *utils.Env) httprouter.Handle

swagger:route GET /charts/{uuid} Charts GetChart

Handler to retrieve a single chart

Returns a single chart

Produces:

application/json

Responses:

200: body:Chart

func GetConfig

func GetConfig(env *utils.Env) httprouter.Handle

swagger:route GET /Configs/{uuid} Configs GetConfig

Handler to retrieve the config

This will the config data

Produces:

application/json

Responses:

200: ConfigResponse
404: ResourceStatusResponse

func GetLogFile

func GetLogFile(env *utils.Env) httprouter.Handle

swagger:route GET /logFiles/{uuid} logFiles GetLogFile

Handler to retrieve a single logFile

This will return a single log

Produces:

application/json

Responses:

200: LogFileResponse
404: ResourceStatusResponse

func GetSheet

func GetSheet(env *utils.Env) httprouter.Handle

swagger:route GET /sheets/{uuid} Sheets GetSheet

Handler to retrieve a single sheets

This will return a single sheet

Produces:

application/json

Responses:

200: body:SheetResponse

func GetWorkspace

func GetWorkspace(env *utils.Env) httprouter.Handle

swagger:route GET /workspaces/{uuid} Workspaces GetWorkspace

Handler to retrieve a single workspaces

This will return a single workspace

Produces:

application/json

Responses:

200: body:WorkspaceResponse

func Login

func Login(env *utils.Env) httprouter.Handle

swagger:route POST /login Authentication Login

Handler to login

Returns a JWT on success

Produces:

application/json

Responses:

200: body:LoginSuccessResponse

func Logout

func Logout(env *utils.Env) httprouter.Handle

Logout adds the current token to the blacklist so it can't be used again swagger:route POST /logout Authentication logout

Handler to logout

Returns OK

Produces:

application/json

Responses:

200:

func RefreshToken

func RefreshToken(env *utils.Env) httprouter.Handle

RefreshToken returns a new token swagger:route POST /refreshToken Authentication refresh

Handler that returns a new token if not expired

Produces

application/json

Responses:

200: body:LoginSuccessResponse

func UpdateChart

func UpdateChart(env *utils.Env) httprouter.Handle

swagger:route PUT /charts/{uuid} Charts UpdateChart

Handler to update a chart

Replaces an existing chart with new values Produces:

application/json

Responses:

200: ResourceStatusResponse

func UpdateConfig

func UpdateConfig(env *utils.Env) httprouter.Handle

swagger:route PUT /Config/{uuid} Config UpdateConfig

Handler to update an existing Config object

This will update an existing Config object

Produces:

application/json

Responses:

200: ResourceStatusResponse

func UpdateLogFile

func UpdateLogFile(env *utils.Env) httprouter.Handle

swagger:route PUT /logFiles/{uuid} logFiles UpdateLogFile

Handler to update the logFile name

This will allow updating of the log name

Consumes:

application/json

Responses:

default: ResourceStatusResponse

func UpdateSheet

func UpdateSheet(env *utils.Env) httprouter.Handle

swagger:route PUT /sheets/{uuid} Sheets UpdateSheet

Handler to update an existing sheet object

This will update an existing sheet object Only charts that exist can be added

Produces:

application/json

Responses:

200: ResourceStatusResponse

func UpdateUser

func UpdateUser(env *utils.Env) httprouter.Handle

swagger:route PUT /users/{uuid} Users UpdateUser

Handler to update a user

Replaces an existing user with new values Produces:

application/json

Responses:

200: ResourceStatusResponse

func UpdateWorkspace

func UpdateWorkspace(env *utils.Env) httprouter.Handle

swagger:route PUT /workspaces/{uuid} Workspaces UpdateWorkspace

Handler to update an existing workspace object

This will update an existing workspace object Only sheets that exist can be added

Produces:

application/json

Responses:

200: ResourceStatusResponse

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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