api

package

v1.0.2 Latest Latest Go to latest Published: Mar 13, 2026 License: BSD-3-Clause Imports: 9 Imported by: 0

Documentation ¶

Index ¶

type Server
- func NewServer(c client.Client, versionInfo VersionInfo) *Server
type VersionInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

Server handles REST API requests.

func NewServer ¶

func NewServer(c client.Client, versionInfo VersionInfo) *Server

NewServer creates a new API server instance.

func (*Server) ApplyNowServer ¶

func (s *Server) ApplyNowServer(
	ctx context.Context,
	req generated.ApplyNowServerRequestObject,
) (generated.ApplyNowServerResponseObject, error)

ApplyNowServer implements applying pending updates immediately.

func (*Server) CreatePlugin ¶

func (s *Server) CreatePlugin(
	ctx context.Context,
	req generated.CreatePluginRequestObject,
) (generated.CreatePluginResponseObject, error)

CreatePlugin implements creating a new plugin.

func (*Server) CreateServer ¶

func (s *Server) CreateServer(
	ctx context.Context,
	req generated.CreateServerRequestObject,
) (generated.CreateServerResponseObject, error)

CreateServer implements creating a new PaperMC server.

func (*Server) DeletePlugin ¶

func (s *Server) DeletePlugin(
	ctx context.Context,
	req generated.DeletePluginRequestObject,
) (generated.DeletePluginResponseObject, error)

DeletePlugin implements deleting a plugin.

func (*Server) DeleteServer ¶

func (s *Server) DeleteServer(
	ctx context.Context,
	req generated.DeleteServerRequestObject,
) (generated.DeleteServerResponseObject, error)

DeleteServer implements deleting a server.

func (*Server) GetHealth ¶

func (s *Server) GetHealth(
	ctx context.Context,
	_ generated.GetHealthRequestObject,
) (generated.GetHealthResponseObject, error)

GetHealth implements the health check endpoint.

func (*Server) GetPlugin ¶

func (s *Server) GetPlugin(
	ctx context.Context,
	req generated.GetPluginRequestObject,
) (generated.GetPluginResponseObject, error)

GetPlugin implements getting a specific plugin.

func (*Server) GetServer ¶

func (s *Server) GetServer(
	ctx context.Context,
	req generated.GetServerRequestObject,
) (generated.GetServerResponseObject, error)

GetServer implements getting a specific server.

func (*Server) GetVersion ¶

func (s *Server) GetVersion(
	_ context.Context,
	_ generated.GetVersionRequestObject,
) (generated.GetVersionResponseObject, error)

GetVersion implements the version endpoint.

func (*Server) Handler ¶

func (s *Server) Handler() http.Handler

Handler returns an HTTP handler for the API server. The handler should be mounted at /api/v1/.

func (*Server) ListNamespaces ¶

func (s *Server) ListNamespaces(
	ctx context.Context,
	_ generated.ListNamespacesRequestObject,
) (generated.ListNamespacesResponseObject, error)

ListNamespaces implements listing available namespaces.

func (*Server) ListPlugins ¶

func (s *Server) ListPlugins(
	ctx context.Context,
	req generated.ListPluginsRequestObject,
) (generated.ListPluginsResponseObject, error)

ListPlugins implements listing all plugins.

func (*Server) ListServers ¶

func (s *Server) ListServers(
	ctx context.Context,
	req generated.ListServersRequestObject,
) (generated.ListServersResponseObject, error)

ListServers implements listing all PaperMC servers.

func (*Server) ResolvePlugin ¶

func (s *Server) ResolvePlugin(
	ctx context.Context,
	req generated.ResolvePluginRequestObject,
) (generated.ResolvePluginResponseObject, error)

ResolvePlugin implements triggering plugin reconciliation.

func (*Server) ResolveServer ¶

func (s *Server) ResolveServer(
	ctx context.Context,
	req generated.ResolveServerRequestObject,
) (generated.ResolveServerResponseObject, error)

ResolveServer implements triggering server reconciliation.

func (*Server) UpdatePlugin ¶

func (s *Server) UpdatePlugin(
	ctx context.Context,
	req generated.UpdatePluginRequestObject,
) (generated.UpdatePluginResponseObject, error)

UpdatePlugin implements updating an existing plugin.

func (*Server) UpdateServer ¶

func (s *Server) UpdateServer(
	ctx context.Context,
	req generated.UpdateServerRequestObject,
) (generated.UpdateServerResponseObject, error)

UpdateServer implements updating an existing server.

type VersionInfo ¶

type VersionInfo struct {
	Version   string
	GitCommit string
	BuildDate string
	GoVersion string
}

VersionInfo contains version information about the operator.

Source Files ¶

View all Source files

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