app

Documentation

Index

• func AllApplications(c *fiber.Ctx) error
• func Details(c *fiber.Ctx) error
• func Recreate(c *fiber.Ctx) error
• func Refresh(c *fiber.Ctx) error
• func Register(c *fiber.Ctx) error
• func Remove(c *fiber.Ctx) error
• func Update(c *fiber.Ctx) error
• type GlobalResponse

Functions

func AllApplications

func AllApplications(c *fiber.Ctx) error

AllApplications godoc

@summary	Get a list all applications created
@tags		Apps
@Security	ApiKeyAuth || cookies
@success	200	{object}	core.AppList
@router		/apps [get]

func Details

func Details(c *fiber.Ctx) error

Details godoc @summary Get details of an application @tags Apps @Security ApiKeyAuth || cookies @param app_name path string true "Application name" @produce json @success 200 {object} application.Application @failure 400 {object} GlobalResponse @failure 500 {object} GlobalResponse @router /apps/{app_name} [get]

func Recreate

func Recreate(c *fiber.Ctx) error

Recreate godoc

@summary	Recreate application
@tags		Apps
@Security	ApiKeyAuth || cookies
@param		app_name	path	string	true	"Application name"
@success	200
@failure	500	{object}	GlobalResponse
@router		/apps/{app_name}/recreate [post]

func Refresh

func Refresh(c *fiber.Ctx) error

Refresh godoc

@summary	Refresh/Synchronize an application
@tags		Apps
@Security	ApiKeyAuth || cookies
@param		app_name	path	string	true	"Application name"
@success	200
@failure	500	{object}	GlobalResponse
@router		/apps/{app_name}/refresh [post]

func Register

func Register(c *fiber.Ctx) error

Register godoc

@summary	Create a new application
@tags		Apps
@accept		json
@produce	json
@Security	ApiKeyAuth || cookies
@param		request	body		application.Application	true	"Application body"
@success	200		{object}	GlobalResponse
@failure	400		{object}	GlobalResponse
@failure	500		{object}	GlobalResponse
@router		/apps [post]

func Remove

func Remove(c *fiber.Ctx) error

Remove godoc

@summary	Remove an application
@tags		Apps
@Security	ApiKeyAuth || cookies
@param		app_name	path	string	true	"Application name"
@success	200
@failure	500	{object}	GlobalResponse
@router		/apps/{app_name} [delete]

func Update

func Update(c *fiber.Ctx) error

Update godoc

@summary	Update an application
@tags		Apps
@Security	ApiKeyAuth || cookies
@accept		json
@produce	json
@param		request	body	application.Application	true	"Application body"
@success	202
@failure	400	{object}	GlobalResponse
@failure	500	{object}	GlobalResponse
@router		/apps [put]

Types

type GlobalResponse

type GlobalResponse struct {
	Message string `json:"message"`
}