Documentation
¶
Overview ¶
TODO: Describe package
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Create ¶
func Create() gin.HandlerFunc
TODO: Describe function
@Summary Create an operator config
@Schemes
@Description Create an operator config
@Tags operatorconfigs
@Accept application/json
@Produce application/json
@Param operatorconfig body apicontracts.OperatorConfig true "Add an operator config"
@Success 200 {object} apicontracts.OperatorConfig
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/operatorconfigs [post]
@Security ApiKey || AccessToken
func Delete ¶
func Delete() gin.HandlerFunc
TODO: Describe function
@Summary Delete an operator config
@Schemes
@Description Delete an operator config by id
@Tags operatorconfigs
@Accept application/json
@Produce application/json
@Param id path string true "id"
@Success 200 {boolean} true
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/operatorconfigs/{id} [delete]
@Security ApiKey || AccessToken
func GetAll ¶
func GetAll() gin.HandlerFunc
TODO: Describe function
@Summary Get all operator configs
@Schemes
@Description Get all operator configs
@Tags operatorconfigs
@Accept application/json
@Produce application/json
@Success 200 {array} apicontracts.OperatorConfig
@Failure 403 {string} Forbidden
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/operatorconfigs [get]
@Security ApiKey || AccessToken
func GetById ¶
func GetById() gin.HandlerFunc
TODO: Describe function
@Summary Get an operator config
@Schemes
@Description Get an operator config by id
@Tags operatorconfigs
@Accept application/json
@Produce application/json
@Param id path string true "id"
@Success 200 {object} apicontracts.OperatorConfig
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/operatorconfigs/{id} [get]
@Security ApiKey || AccessToken
func Update ¶
func Update() gin.HandlerFunc
TODO: Describe function
@Summary Update an operator config
@Schemes
@Description Update an operator config by id
@Tags operatorconfigs
@Accept application/json
@Produce application/json
@Param id path string true "id"
@Param operatorconfig body apicontracts.OperatorConfig true "Update operator config"
@Success 200 {object} apicontracts.OperatorConfig
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/operatorconfigs/{id} [put]
@Security ApiKey || AccessToken
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.