api

package

v0.0.28 Latest Latest Go to latest Published: Mar 18, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SENERGY-Platform/import-deploy

Links

Open Source Insights

Documentation ¶

Index ¶

func DocEndpoint(config config.Config, control Controller, router *gin.Engine)
func InstancesEndpoints(_ config.Config, control Controller, router *gin.Engine)
func Start(config config.Config, control Controller) (err error)
type Controller
type ErrorResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DocEndpoint ¶ added in v0.0.28

func DocEndpoint(config config.Config, control Controller, router *gin.Engine)

func InstancesEndpoints ¶

func InstancesEndpoints(_ config.Config, control Controller, router *gin.Engine)

func Start ¶

func Start(config config.Config, control Controller) (err error)

Start godoc @title Import Deploy API @description Launches and stops import instances and provides information about them. @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization

Types ¶

type Controller ¶

type Controller interface {
	ListInstances(jwt jwt.Token, limit int64, offset int64, sort string, asc bool, search string, includeGenerated bool) (results []model.Instance, err error, errCode int)
	ReadInstance(id string, jwt jwt.Token) (result model.Instance, err error, errCode int)
	CreateInstance(instance model.Instance, jwt jwt.Token) (result model.Instance, err error, code int)
	SetInstance(importType model.Instance, jwt jwt.Token) (err error, code int)
	DeleteInstance(id string, jwt jwt.Token) (err error, errCode int)
	CountInstances(jwt jwt.Token, search string, includeGenerated bool) (count int64, err error, errCode int)
}

type ErrorResponse ¶ added in v0.0.28

type ErrorResponse string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL