prices

Documentation

Overview

TODO: Describe package

Index

• func Create() gin.HandlerFunc
• func Delete() gin.HandlerFunc
• func GetAll() gin.HandlerFunc
• func GetById() gin.HandlerFunc
• func GetByProvider() gin.HandlerFunc
• func Update() gin.HandlerFunc

Functions

func Create

func Create() gin.HandlerFunc

TODO: Describe function

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

func Delete

func Delete() gin.HandlerFunc

TODO: Describe function

@Summary	Delete a price
@Schemes
@Description	Delete a price by id
@Tags			prices
@Accept			application/json
@Produce		application/json
@Param			id	path		string	true	"id"
@Success		200	{bool}		true
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/prices/:id [delete]
@Security		ApiKey || AccessToken

func GetAll

func GetAll() gin.HandlerFunc

TODO: Describe function

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

func GetById

func GetById() gin.HandlerFunc

TODO: Describe function

func GetByProvider

func GetByProvider() gin.HandlerFunc

TODO: Describe function

@Summary	Get prices by provider
@Schemes
@Description	Get prices by provider
@Tags			prices
@Accept			application/json
@Produce		application/json
@Param			providerName	path		string	true	"providerName"
@Success		200				{array}		apicontracts.Price
@Failure		403				{string}	Forbidden
@Failure		401				{string}	Unauthorized
@Failure		500				{string}	Failure	message
@Router			/v1/prices/provider/{providerName} [get]
@Security		ApiKey || AccessToken

func Update

func Update() gin.HandlerFunc

TODO: Describe function

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