network

package

v0.0.0-...-3da861f Latest Latest Go to latest Published: Apr 10, 2026 License: MIT Imports: 18 Imported by: 0

Details

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

Repository

github.com/retr0h/osapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package network provides network-related API handlers.

Index ¶

func Handler(logger *slog.Logger, jobClient client.JobClient, signingKey string, ...) []func(e *echo.Echo)
type Network
- func New(logger *slog.Logger, jobClient client.JobClient) *Network

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(
	logger *slog.Logger,
	jobClient client.JobClient,
	signingKey string,
	customRoles map[string][]string,
) []func(e *echo.Echo)

Handler returns Network route registration functions.

Types ¶

type Network ¶

type Network struct {
	// JobClient provides job-based operations for network management.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

Network implementation of the Network APIs operations.

func New ¶

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *Network

New factory to create a new instance.

func (*Network) DeleteNodeNetworkDNS ¶

func (s *Network) DeleteNodeNetworkDNS(
	ctx context.Context,
	request gen.DeleteNodeNetworkDNSRequestObject,
) (gen.DeleteNodeNetworkDNSResponseObject, error)

DeleteNodeNetworkDNS delete the node network DNS configuration API endpoint.

func (*Network) DeleteNodeNetworkInterface ¶

func (s *Network) DeleteNodeNetworkInterface(
	ctx context.Context,
	request gen.DeleteNodeNetworkInterfaceRequestObject,
) (gen.DeleteNodeNetworkInterfaceResponseObject, error)

DeleteNodeNetworkInterface delete the node network interface API endpoint.

func (*Network) DeleteNodeNetworkRoute ¶

func (s *Network) DeleteNodeNetworkRoute(
	ctx context.Context,
	request gen.DeleteNodeNetworkRouteRequestObject,
) (gen.DeleteNodeNetworkRouteResponseObject, error)

DeleteNodeNetworkRoute delete the node network routes by interface API endpoint.

func (*Network) GetNodeNetworkDNSByInterface ¶

func (s *Network) GetNodeNetworkDNSByInterface(
	ctx context.Context,
	request gen.GetNodeNetworkDNSByInterfaceRequestObject,
) (gen.GetNodeNetworkDNSByInterfaceResponseObject, error)

GetNodeNetworkDNSByInterface get the node network dns get API endpoint.

func (*Network) GetNodeNetworkInterface ¶

func (s *Network) GetNodeNetworkInterface(
	ctx context.Context,
	request gen.GetNodeNetworkInterfaceRequestObject,
) (gen.GetNodeNetworkInterfaceResponseObject, error)

GetNodeNetworkInterface get the node network interface list API endpoint.

func (*Network) GetNodeNetworkInterfaceByName ¶

func (s *Network) GetNodeNetworkInterfaceByName(
	ctx context.Context,
	request gen.GetNodeNetworkInterfaceByNameRequestObject,
) (gen.GetNodeNetworkInterfaceByNameResponseObject, error)

GetNodeNetworkInterfaceByName get the node network interface by name API endpoint.

func (*Network) GetNodeNetworkRoute ¶

func (s *Network) GetNodeNetworkRoute(
	ctx context.Context,
	request gen.GetNodeNetworkRouteRequestObject,
) (gen.GetNodeNetworkRouteResponseObject, error)

GetNodeNetworkRoute get the node network route list API endpoint.

func (*Network) GetNodeNetworkRouteByInterface ¶

func (s *Network) GetNodeNetworkRouteByInterface(
	ctx context.Context,
	request gen.GetNodeNetworkRouteByInterfaceRequestObject,
) (gen.GetNodeNetworkRouteByInterfaceResponseObject, error)

GetNodeNetworkRouteByInterface get the node network routes by interface API endpoint.

func (*Network) PostNodeNetworkInterface ¶

func (s *Network) PostNodeNetworkInterface(
	ctx context.Context,
	request gen.PostNodeNetworkInterfaceRequestObject,
) (gen.PostNodeNetworkInterfaceResponseObject, error)

PostNodeNetworkInterface post the node network interface create API endpoint.

func (*Network) PostNodeNetworkPing ¶

func (s *Network) PostNodeNetworkPing(
	ctx context.Context,
	request gen.PostNodeNetworkPingRequestObject,
) (gen.PostNodeNetworkPingResponseObject, error)

PostNodeNetworkPing post the node network ping API endpoint.

func (*Network) PostNodeNetworkRoute ¶

func (s *Network) PostNodeNetworkRoute(
	ctx context.Context,
	request gen.PostNodeNetworkRouteRequestObject,
) (gen.PostNodeNetworkRouteResponseObject, error)

PostNodeNetworkRoute post the node network route create API endpoint.

func (*Network) PutNodeNetworkDNS ¶

func (s *Network) PutNodeNetworkDNS(
	ctx context.Context,
	request gen.PutNodeNetworkDNSRequestObject,
) (gen.PutNodeNetworkDNSResponseObject, error)

PutNodeNetworkDNS put the node network dns API endpoint.

func (*Network) PutNodeNetworkInterface ¶

func (s *Network) PutNodeNetworkInterface(
	ctx context.Context,
	request gen.PutNodeNetworkInterfaceRequestObject,
) (gen.PutNodeNetworkInterfaceResponseObject, error)

PutNodeNetworkInterface put the node network interface update API endpoint.

func (*Network) PutNodeNetworkRoute ¶

func (s *Network) PutNodeNetworkRoute(
	ctx context.Context,
	request gen.PutNodeNetworkRouteRequestObject,
) (gen.PutNodeNetworkRouteResponseObject, error)

PutNodeNetworkRoute put the node network route update API endpoint.

Directories ¶

Path	Synopsis
gen Package gen contains generated code for the network API.	Package gen contains generated code for the network API.

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