gen

package
v0.0.0-...-36c55c0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package gen contains generated code for the package management API.

Package gen provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type DeleteNodePackage200JSONResponse

type DeleteNodePackage200JSONResponse PackageMutationResponse

func (DeleteNodePackage200JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage200JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackage400JSONResponse

type DeleteNodePackage400JSONResponse externalRef0.ErrorResponse

func (DeleteNodePackage400JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage400JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackage401JSONResponse

type DeleteNodePackage401JSONResponse externalRef0.ErrorResponse

func (DeleteNodePackage401JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage401JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackage403JSONResponse

type DeleteNodePackage403JSONResponse externalRef0.ErrorResponse

func (DeleteNodePackage403JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage403JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackage404JSONResponse

type DeleteNodePackage404JSONResponse externalRef0.ErrorResponse

func (DeleteNodePackage404JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage404JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackage500JSONResponse

type DeleteNodePackage500JSONResponse externalRef0.ErrorResponse

func (DeleteNodePackage500JSONResponse) VisitDeleteNodePackageResponse

func (response DeleteNodePackage500JSONResponse) VisitDeleteNodePackageResponse(w http.ResponseWriter) error

type DeleteNodePackageRequestObject

type DeleteNodePackageRequestObject struct {
	Hostname Hostname    `json:"hostname"`
	Name     PackageName `json:"name"`
}

type DeleteNodePackageResponseObject

type DeleteNodePackageResponseObject interface {
	VisitDeleteNodePackageResponse(w http.ResponseWriter) error
}

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type ErrorResponse

type ErrorResponse = externalRef0.ErrorResponse

ErrorResponse defines model for ErrorResponse.

type GetNodePackage200JSONResponse

type GetNodePackage200JSONResponse PackageCollectionResponse

func (GetNodePackage200JSONResponse) VisitGetNodePackageResponse

func (response GetNodePackage200JSONResponse) VisitGetNodePackageResponse(w http.ResponseWriter) error

type GetNodePackage400JSONResponse

type GetNodePackage400JSONResponse externalRef0.ErrorResponse

func (GetNodePackage400JSONResponse) VisitGetNodePackageResponse

func (response GetNodePackage400JSONResponse) VisitGetNodePackageResponse(w http.ResponseWriter) error

type GetNodePackage401JSONResponse

type GetNodePackage401JSONResponse externalRef0.ErrorResponse

func (GetNodePackage401JSONResponse) VisitGetNodePackageResponse

func (response GetNodePackage401JSONResponse) VisitGetNodePackageResponse(w http.ResponseWriter) error

type GetNodePackage403JSONResponse

type GetNodePackage403JSONResponse externalRef0.ErrorResponse

func (GetNodePackage403JSONResponse) VisitGetNodePackageResponse

func (response GetNodePackage403JSONResponse) VisitGetNodePackageResponse(w http.ResponseWriter) error

type GetNodePackage500JSONResponse

type GetNodePackage500JSONResponse externalRef0.ErrorResponse

func (GetNodePackage500JSONResponse) VisitGetNodePackageResponse

func (response GetNodePackage500JSONResponse) VisitGetNodePackageResponse(w http.ResponseWriter) error

type GetNodePackageByName200JSONResponse

type GetNodePackageByName200JSONResponse PackageCollectionResponse

func (GetNodePackageByName200JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName200JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByName400JSONResponse

type GetNodePackageByName400JSONResponse externalRef0.ErrorResponse

func (GetNodePackageByName400JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName400JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByName401JSONResponse

type GetNodePackageByName401JSONResponse externalRef0.ErrorResponse

func (GetNodePackageByName401JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName401JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByName403JSONResponse

type GetNodePackageByName403JSONResponse externalRef0.ErrorResponse

func (GetNodePackageByName403JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName403JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByName404JSONResponse

type GetNodePackageByName404JSONResponse externalRef0.ErrorResponse

func (GetNodePackageByName404JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName404JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByName500JSONResponse

type GetNodePackageByName500JSONResponse externalRef0.ErrorResponse

func (GetNodePackageByName500JSONResponse) VisitGetNodePackageByNameResponse

func (response GetNodePackageByName500JSONResponse) VisitGetNodePackageByNameResponse(w http.ResponseWriter) error

type GetNodePackageByNameRequestObject

type GetNodePackageByNameRequestObject struct {
	Hostname Hostname    `json:"hostname"`
	Name     PackageName `json:"name"`
}

type GetNodePackageByNameResponseObject

type GetNodePackageByNameResponseObject interface {
	VisitGetNodePackageByNameResponse(w http.ResponseWriter) error
}

type GetNodePackageRequestObject

type GetNodePackageRequestObject struct {
	Hostname Hostname `json:"hostname"`
}

type GetNodePackageResponseObject

type GetNodePackageResponseObject interface {
	VisitGetNodePackageResponse(w http.ResponseWriter) error
}

type GetNodePackageUpdate200JSONResponse

type GetNodePackageUpdate200JSONResponse UpdateCollectionResponse

func (GetNodePackageUpdate200JSONResponse) VisitGetNodePackageUpdateResponse

func (response GetNodePackageUpdate200JSONResponse) VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error

type GetNodePackageUpdate400JSONResponse

type GetNodePackageUpdate400JSONResponse externalRef0.ErrorResponse

func (GetNodePackageUpdate400JSONResponse) VisitGetNodePackageUpdateResponse

func (response GetNodePackageUpdate400JSONResponse) VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error

type GetNodePackageUpdate401JSONResponse

type GetNodePackageUpdate401JSONResponse externalRef0.ErrorResponse

func (GetNodePackageUpdate401JSONResponse) VisitGetNodePackageUpdateResponse

func (response GetNodePackageUpdate401JSONResponse) VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error

type GetNodePackageUpdate403JSONResponse

type GetNodePackageUpdate403JSONResponse externalRef0.ErrorResponse

func (GetNodePackageUpdate403JSONResponse) VisitGetNodePackageUpdateResponse

func (response GetNodePackageUpdate403JSONResponse) VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error

type GetNodePackageUpdate500JSONResponse

type GetNodePackageUpdate500JSONResponse externalRef0.ErrorResponse

func (GetNodePackageUpdate500JSONResponse) VisitGetNodePackageUpdateResponse

func (response GetNodePackageUpdate500JSONResponse) VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error

type GetNodePackageUpdateRequestObject

type GetNodePackageUpdateRequestObject struct {
	Hostname Hostname `json:"hostname"`
}

type GetNodePackageUpdateResponseObject

type GetNodePackageUpdateResponseObject interface {
	VisitGetNodePackageUpdateResponse(w http.ResponseWriter) error
}

type Hostname

type Hostname = string

Hostname defines model for Hostname.

type PackageCollectionResponse

type PackageCollectionResponse struct {
	// JobId The job ID used to process this request.
	JobId   *openapi_types.UUID `json:"job_id,omitempty"`
	Results []PackageEntry      `json:"results"`
}

PackageCollectionResponse defines model for PackageCollectionResponse.

type PackageEntry

type PackageEntry struct {
	// Error Error message if the agent failed.
	Error *string `json:"error,omitempty"`

	// Hostname Hostname of the agent that reported this entry.
	Hostname string `json:"hostname"`

	// Packages List of packages.
	Packages *[]PackageInfo `json:"packages,omitempty"`

	// Status The status of the operation for this host.
	Status PackageEntryStatus `json:"status"`
}

PackageEntry A package list result for one host.

type PackageEntryStatus

type PackageEntryStatus string

PackageEntryStatus The status of the operation for this host.

const (
	PackageEntryStatusFailed  PackageEntryStatus = "failed"
	PackageEntryStatusOk      PackageEntryStatus = "ok"
	PackageEntryStatusSkipped PackageEntryStatus = "skipped"
)

Defines values for PackageEntryStatus.

type PackageInfo

type PackageInfo struct {
	// Description Package description.
	Description *string `json:"description,omitempty"`

	// Name Package name.
	Name *string `json:"name,omitempty"`

	// Size Installed size in bytes.
	Size *int64 `json:"size,omitempty"`

	// Status Package status (e.g., installed).
	Status *string `json:"status,omitempty"`

	// Version Installed version.
	Version *string `json:"version,omitempty"`
}

PackageInfo Information about an installed package.

type PackageInstallRequest

type PackageInstallRequest struct {
	// Name Name of the package to install.
	Name string `json:"name" validate:"required,min=1"`
}

PackageInstallRequest defines model for PackageInstallRequest.

type PackageMutationResponse

type PackageMutationResponse struct {
	// JobId The job ID used to process this request.
	JobId   *openapi_types.UUID     `json:"job_id,omitempty"`
	Results []PackageMutationResult `json:"results"`
}

PackageMutationResponse defines model for PackageMutationResponse.

type PackageMutationResult

type PackageMutationResult struct {
	// Changed Whether the operation modified system state.
	Changed *bool `json:"changed,omitempty"`

	// Error Error message if the agent failed.
	Error *string `json:"error,omitempty"`

	// Hostname Hostname of the agent that processed this operation.
	Hostname string `json:"hostname"`

	// Name Package name.
	Name *string `json:"name,omitempty"`

	// Status The status of the operation for this host.
	Status PackageMutationResultStatus `json:"status"`
}

PackageMutationResult Result of a package install, remove, or update operation for one host.

type PackageMutationResultStatus

type PackageMutationResultStatus string

PackageMutationResultStatus The status of the operation for this host.

const (
	PackageMutationResultStatusFailed  PackageMutationResultStatus = "failed"
	PackageMutationResultStatusOk      PackageMutationResultStatus = "ok"
	PackageMutationResultStatusSkipped PackageMutationResultStatus = "skipped"
)

Defines values for PackageMutationResultStatus.

type PackageName

type PackageName = string

PackageName defines model for PackageName.

type PostNodePackage200JSONResponse

type PostNodePackage200JSONResponse PackageMutationResponse

func (PostNodePackage200JSONResponse) VisitPostNodePackageResponse

func (response PostNodePackage200JSONResponse) VisitPostNodePackageResponse(w http.ResponseWriter) error

type PostNodePackage400JSONResponse

type PostNodePackage400JSONResponse externalRef0.ErrorResponse

func (PostNodePackage400JSONResponse) VisitPostNodePackageResponse

func (response PostNodePackage400JSONResponse) VisitPostNodePackageResponse(w http.ResponseWriter) error

type PostNodePackage401JSONResponse

type PostNodePackage401JSONResponse externalRef0.ErrorResponse

func (PostNodePackage401JSONResponse) VisitPostNodePackageResponse

func (response PostNodePackage401JSONResponse) VisitPostNodePackageResponse(w http.ResponseWriter) error

type PostNodePackage403JSONResponse

type PostNodePackage403JSONResponse externalRef0.ErrorResponse

func (PostNodePackage403JSONResponse) VisitPostNodePackageResponse

func (response PostNodePackage403JSONResponse) VisitPostNodePackageResponse(w http.ResponseWriter) error

type PostNodePackage500JSONResponse

type PostNodePackage500JSONResponse externalRef0.ErrorResponse

func (PostNodePackage500JSONResponse) VisitPostNodePackageResponse

func (response PostNodePackage500JSONResponse) VisitPostNodePackageResponse(w http.ResponseWriter) error

type PostNodePackageJSONRequestBody

type PostNodePackageJSONRequestBody = PackageInstallRequest

PostNodePackageJSONRequestBody defines body for PostNodePackage for application/json ContentType.

type PostNodePackageRequestObject

type PostNodePackageRequestObject struct {
	Hostname Hostname `json:"hostname"`
	Body     *PostNodePackageJSONRequestBody
}

type PostNodePackageResponseObject

type PostNodePackageResponseObject interface {
	VisitPostNodePackageResponse(w http.ResponseWriter) error
}

type PostNodePackageUpdate200JSONResponse

type PostNodePackageUpdate200JSONResponse PackageMutationResponse

func (PostNodePackageUpdate200JSONResponse) VisitPostNodePackageUpdateResponse

func (response PostNodePackageUpdate200JSONResponse) VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error

type PostNodePackageUpdate400JSONResponse

type PostNodePackageUpdate400JSONResponse externalRef0.ErrorResponse

func (PostNodePackageUpdate400JSONResponse) VisitPostNodePackageUpdateResponse

func (response PostNodePackageUpdate400JSONResponse) VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error

type PostNodePackageUpdate401JSONResponse

type PostNodePackageUpdate401JSONResponse externalRef0.ErrorResponse

func (PostNodePackageUpdate401JSONResponse) VisitPostNodePackageUpdateResponse

func (response PostNodePackageUpdate401JSONResponse) VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error

type PostNodePackageUpdate403JSONResponse

type PostNodePackageUpdate403JSONResponse externalRef0.ErrorResponse

func (PostNodePackageUpdate403JSONResponse) VisitPostNodePackageUpdateResponse

func (response PostNodePackageUpdate403JSONResponse) VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error

type PostNodePackageUpdate500JSONResponse

type PostNodePackageUpdate500JSONResponse externalRef0.ErrorResponse

func (PostNodePackageUpdate500JSONResponse) VisitPostNodePackageUpdateResponse

func (response PostNodePackageUpdate500JSONResponse) VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error

type PostNodePackageUpdateRequestObject

type PostNodePackageUpdateRequestObject struct {
	Hostname Hostname `json:"hostname"`
}

type PostNodePackageUpdateResponseObject

type PostNodePackageUpdateResponseObject interface {
	VisitPostNodePackageUpdateResponse(w http.ResponseWriter) error
}

type ServerInterface

type ServerInterface interface {
	// List installed packages
	// (GET /api/node/{hostname}/package)
	GetNodePackage(ctx echo.Context, hostname Hostname) error
	// Install a package
	// (POST /api/node/{hostname}/package)
	PostNodePackage(ctx echo.Context, hostname Hostname) error
	// List available updates
	// (GET /api/node/{hostname}/package/update)
	GetNodePackageUpdate(ctx echo.Context, hostname Hostname) error
	// Update package sources
	// (POST /api/node/{hostname}/package/update)
	PostNodePackageUpdate(ctx echo.Context, hostname Hostname) error
	// Remove a package
	// (DELETE /api/node/{hostname}/package/{name})
	DeleteNodePackage(ctx echo.Context, hostname Hostname, name PackageName) error
	// Get a package
	// (GET /api/node/{hostname}/package/{name})
	GetNodePackageByName(ctx echo.Context, hostname Hostname, name PackageName) error
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) DeleteNodePackage

func (w *ServerInterfaceWrapper) DeleteNodePackage(ctx echo.Context) error

DeleteNodePackage converts echo context to params.

func (*ServerInterfaceWrapper) GetNodePackage

func (w *ServerInterfaceWrapper) GetNodePackage(ctx echo.Context) error

GetNodePackage converts echo context to params.

func (*ServerInterfaceWrapper) GetNodePackageByName

func (w *ServerInterfaceWrapper) GetNodePackageByName(ctx echo.Context) error

GetNodePackageByName converts echo context to params.

func (*ServerInterfaceWrapper) GetNodePackageUpdate

func (w *ServerInterfaceWrapper) GetNodePackageUpdate(ctx echo.Context) error

GetNodePackageUpdate converts echo context to params.

func (*ServerInterfaceWrapper) PostNodePackage

func (w *ServerInterfaceWrapper) PostNodePackage(ctx echo.Context) error

PostNodePackage converts echo context to params.

func (*ServerInterfaceWrapper) PostNodePackageUpdate

func (w *ServerInterfaceWrapper) PostNodePackageUpdate(ctx echo.Context) error

PostNodePackageUpdate converts echo context to params.

type StrictHandlerFunc

type StrictHandlerFunc = strictecho.StrictEchoHandlerFunc

type StrictMiddlewareFunc

type StrictMiddlewareFunc = strictecho.StrictEchoMiddlewareFunc

type StrictServerInterface

type StrictServerInterface interface {
	// List installed packages
	// (GET /api/node/{hostname}/package)
	GetNodePackage(ctx context.Context, request GetNodePackageRequestObject) (GetNodePackageResponseObject, error)
	// Install a package
	// (POST /api/node/{hostname}/package)
	PostNodePackage(ctx context.Context, request PostNodePackageRequestObject) (PostNodePackageResponseObject, error)
	// List available updates
	// (GET /api/node/{hostname}/package/update)
	GetNodePackageUpdate(ctx context.Context, request GetNodePackageUpdateRequestObject) (GetNodePackageUpdateResponseObject, error)
	// Update package sources
	// (POST /api/node/{hostname}/package/update)
	PostNodePackageUpdate(ctx context.Context, request PostNodePackageUpdateRequestObject) (PostNodePackageUpdateResponseObject, error)
	// Remove a package
	// (DELETE /api/node/{hostname}/package/{name})
	DeleteNodePackage(ctx context.Context, request DeleteNodePackageRequestObject) (DeleteNodePackageResponseObject, error)
	// Get a package
	// (GET /api/node/{hostname}/package/{name})
	GetNodePackageByName(ctx context.Context, request GetNodePackageByNameRequestObject) (GetNodePackageByNameResponseObject, error)
}

StrictServerInterface represents all server handlers.

type UpdateCollectionResponse

type UpdateCollectionResponse struct {
	// JobId The job ID used to process this request.
	JobId   *openapi_types.UUID `json:"job_id,omitempty"`
	Results []UpdateEntry       `json:"results"`
}

UpdateCollectionResponse defines model for UpdateCollectionResponse.

type UpdateEntry

type UpdateEntry struct {
	// Error Error message if the agent failed.
	Error *string `json:"error,omitempty"`

	// Hostname Hostname of the agent that reported this entry.
	Hostname string `json:"hostname"`

	// Status The status of the operation for this host.
	Status UpdateEntryStatus `json:"status"`

	// Updates List of available updates.
	Updates *[]UpdateInfo `json:"updates,omitempty"`
}

UpdateEntry An update list result for one host.

type UpdateEntryStatus

type UpdateEntryStatus string

UpdateEntryStatus The status of the operation for this host.

const (
	Failed  UpdateEntryStatus = "failed"
	Ok      UpdateEntryStatus = "ok"
	Skipped UpdateEntryStatus = "skipped"
)

Defines values for UpdateEntryStatus.

type UpdateInfo

type UpdateInfo struct {
	// CurrentVersion Currently installed version.
	CurrentVersion *string `json:"current_version,omitempty"`

	// Name Package name.
	Name *string `json:"name,omitempty"`

	// NewVersion Available version.
	NewVersion *string `json:"new_version,omitempty"`
}

UpdateInfo Information about an available package update.

Jump to

Keyboard shortcuts

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