datacenterscontroller

Documentation

Overview

TODO: Describe package

Index

• func Create() gin.HandlerFunc
• func GetAll() gin.HandlerFunc
• func GetById() gin.HandlerFunc
• func GetByName() gin.HandlerFunc
• func Update() gin.HandlerFunc

Functions

func Create

func Create() gin.HandlerFunc

TODO: Describe function

@Summary	Create datacenter
@Schemes
@Description	Create datacenter
@Tags			datacenters
@Accept			application/json
@Produce		application/json
@Success		200				{array}		apicontracts.Datacenter
@Failure		403				{string}	Forbidden
@Failure		401				{string}	Unauthorized
@Failure		500				{string}	Failure					message
@Param			datacenter		body		apicontracts.Datacenter	true	"Datacenter"
@Router			/v1/datacenters	[post]
@Security		ApiKey || AccessToken

func GetAll

func GetAll() gin.HandlerFunc

TODO: Describe function

@Summary	Get datacenters
@Schemes
@Description	Get datacenters
@Tags			datacenters
@Accept			application/json
@Produce		application/json
@Success		200				{array}		apicontracts.Datacenter
@Failure		403				{string}	Forbidden
@Failure		401				{string}	Unauthorized
@Failure		500				{string}	Failure	message
@Router			/v1/datacenters	[get]
@Security		ApiKey || AccessToken

func GetById

func GetById() gin.HandlerFunc

@Summary Get datacenter by id @Schemes @Description Get datacenter by id @Tags datacenters @Accept application/json @Produce application/json @Success 200 {object} apicontracts.Datacenter @Failure 403 {string} Forbidden @Failure 401 {string} Unauthorized @Failure 500 {string} Failure message @Router /v1/datacenters/id/{id} [get] @Param id path string true "id" @Security ApiKey || AccessToken

func GetByName

func GetByName() gin.HandlerFunc

TODO: Describe function

@Summary	Get datacenter by name
@Schemes
@Description	Get datacenter by name
@Tags			datacenters
@Accept			application/json
@Produce		application/json
@Success		200									{object}	apicontracts.Datacenter
@Failure		403									{string}	Forbidden
@Failure		401									{string}	Unauthorized
@Failure		500									{string}	Failure	message
@Router			/v1/datacenters/{datacenterName}	[get]
@Param			datacenterName						path	string	true	"datacenterName"
@Security		ApiKey || AccessToken

func Update

func Update() gin.HandlerFunc

TODO: Describe function

@Summary	Update a datacenter
@Schemes
@Description	Update a datacenter by id
@Tags			datacenters
@Accept			application/json
@Produce		application/json
@Success		200								{array}		apicontracts.Datacenter
@Failure		403								{string}	Forbidden
@Failure		401								{string}	Unauthorized
@Failure		500								{string}	Failure					message
@Param			datacenterId					path		string					true	"datacenterId"
@Param			datacenter						body		apicontracts.Datacenter	true	"Datacenter"
@Router			/v1/datacenters/{datacenterId}	[put]
@Security		ApiKey || AccessToken