Documentation
¶
Index ¶
- func DeleteInstance()
- func DeleteInstances()
- func DeploymentEndpoints(config config.Config, control Controller, router *httprouter.Router)
- func DocEndpoint(config config.Config, control Controller, router *httprouter.Router)
- func ForwardPermissions(method string, path string) bool
- func GeneratedCheckMultiplePermissions_kafka2mqtt()
- func GeneratedCheckPermission_kafka2mqtt()
- func GeneratedGetResource_kafka2mqtt()
- func GeneratedListAccessibleResourceIds_kafka2mqtt()
- func GeneratedListComputedPermissions_kafka2mqtt()
- func GeneratedListResourcesWithAdminPermission_kafka2mqtt()
- func GeneratedQueryListComputedPermissions_kafka2mqtt()
- func GeneratedSetPermission_kafka2mqtt()
- func GeneratedSwagger()
- func GetInstance()
- func GetInstances()
- func PostInstances()
- func PutInstances()
- func Router(config config.Config, control Controller) http.Handler
- func Start(config config.Config, ctx context.Context, control Controller, ...) (err error)
- type Controller
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteInstance ¶ added in v0.0.9
func DeleteInstance()
Query godoc @Summary Delete instance @Description Deletes a single instance @Produce json @Security Bearer @Param id path string true "ID of the instance to delete" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances/{id} [DELETE]
func DeleteInstances ¶ added in v0.0.9
func DeleteInstances()
Query godoc @Summary Delete instances @Description Deletes a single instance @Produce json @Security Bearer @Param id body []string true "IDs of the instances to delete" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances [DELETE]
func DeploymentEndpoints ¶
func DeploymentEndpoints(config config.Config, control Controller, router *httprouter.Router)
func DocEndpoint ¶ added in v0.0.9
func DocEndpoint(config config.Config, control Controller, router *httprouter.Router)
func ForwardPermissions ¶ added in v0.0.12
func GeneratedCheckMultiplePermissions_kafka2mqtt ¶ added in v0.0.12
func GeneratedCheckMultiplePermissions_kafka2mqtt()
GeneratedCheckMultiplePermissions_kafka2mqtt godoc @Summary check multiple permissions @Description check multiple permissions @Tags permissions-kafka2mqtt @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} map[string]bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/kafka2mqtt [get]
func GeneratedCheckPermission_kafka2mqtt ¶ added in v0.0.12
func GeneratedCheckPermission_kafka2mqtt()
GeneratedCheckPermission_kafka2mqtt godoc @Summary check permission @Description check permission @Tags permissions-kafka2mqtt @Security Bearer @Param id path string true "Resource Id" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/kafka2mqtt/{id} [get]
func GeneratedGetResource_kafka2mqtt ¶ added in v0.0.12
func GeneratedGetResource_kafka2mqtt()
GeneratedGetResource_kafka2mqtt godoc @Summary get resource @Description get resource, requesting user must have admin right on the resource @Tags permissions-kafka2mqtt @Security Bearer @Param id path string true "Resource Id" @Produce json @Success 200 {object} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/kafka2mqtt/{id} [get]
func GeneratedListAccessibleResourceIds_kafka2mqtt ¶ added in v0.0.12
func GeneratedListAccessibleResourceIds_kafka2mqtt()
GeneratedListAccessibleResourceIds_kafka2mqtt godoc @Summary list accessible resource ids @Description list accessible resource ids @Tags permissions-kafka2mqtt @Security Bearer @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} string @Failure 400 @Failure 401 @Failure 500 @Router /permissions/accessible/kafka2mqtt [get]
func GeneratedListComputedPermissions_kafka2mqtt ¶ added in v0.0.12
func GeneratedListComputedPermissions_kafka2mqtt()
GeneratedListComputedPermissions_kafka2mqtt godoc @Summary list the computed permissions to resources of the given topic (kafka2mqtt) and ids @Description list the computed permissions to resources of the given topic (kafka2mqtt) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-kafka2mqtt @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/permissions/kafka2mqtt [get]
func GeneratedListResourcesWithAdminPermission_kafka2mqtt ¶ added in v0.0.12
func GeneratedListResourcesWithAdminPermission_kafka2mqtt()
GeneratedListResourcesWithAdminPermission_kafka2mqtt godoc @Summary lists resources the user has admin rights to @Description lists resources the user has admin rights to @Tags permissions-kafka2mqtt @Security Bearer @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/kafka2mqtt [get]
func GeneratedQueryListComputedPermissions_kafka2mqtt ¶ added in v0.0.12
func GeneratedQueryListComputedPermissions_kafka2mqtt()
GeneratedQueryListComputedPermissions_kafka2mqtt godoc @Summary list the computed permissions to resources of the given topic (kafka2mqtt) and ids @Description list the computed permissions to resources of the given topic (kafka2mqtt) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-kafka2mqtt @Security Bearer @Param ids body []string true "Resource Ids" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/query/permissions/kafka2mqtt [post]
func GeneratedSetPermission_kafka2mqtt ¶ added in v0.0.12
func GeneratedSetPermission_kafka2mqtt()
GeneratedSetPermission_kafka2mqtt godoc @Summary set resource rights @Description get resource rights, requesting user must have admin right @Tags permissions-kafka2mqtt @Security Bearer @Param id path string true "Resource Id" @Param wait query bool false "if set to true, the response will be sent after the corresponding kafka done signal has been received" @Param message body model.ResourcePermissions true "Topic" @Accept json @Produce json @Success 200 {object} model.ResourcePermissions @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/kafka2mqtt/{id} [put]
func GeneratedSwagger ¶ added in v0.0.9
func GeneratedSwagger()
func GetInstance ¶ added in v0.0.9
func GetInstance()
Query godoc @Summary Get instance @Description Provides a single instance @Produce json @Security Bearer @Param id path string true "ID of the requested instance" @Success 200 {object} model.Instance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances/{id} [GET]
func GetInstances ¶ added in v0.0.9
func GetInstances()
Query godoc @Summary Get instances @Description Provides a list of instances @Produce json @Security Bearer @Success 200 {array} model.Instance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances [GET]
func PostInstances ¶ added in v0.0.9
func PostInstances()
Query godoc @Summary Create an instance @Description Creates an instance @Accept json @Produce json @Security Bearer @Param instance body model.Instance true "Instance to create" @Success 200 {object} model.Instance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances [POST]
func PutInstances ¶ added in v0.0.9
func PutInstances()
Query godoc @Summary Update an instance @Description Updates an instance @Accept json @Produce json @Security Bearer @Param instance body model.Instance true "Instance to update" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /instances [PUT]
func Router ¶
func Router(config config.Config, control Controller) http.Handler
GetRouter doc @title Kafka2MQTT API @version 0.1 @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization @description Type "Bearer" followed by a space and JWT token.
Types ¶
type Controller ¶
type Controller interface {
ListInstances(token string, limit int64, offset int64, sort string, asc bool, search string, includeGenerated bool) (results []model.Instance, total int, err error, errCode int)
ReadInstance(token string, id string) (result model.Instance, err error, errCode int)
CreateInstance(instance model.Instance, userId string, token string) (result model.Instance, err error, code int)
SetInstance(importType model.Instance, userId string, token string) (err error, code int)
DeleteInstances(token string, ids []string) (err error, errCode int)
}
Source Files
Directories