package
0.0.0-20250109065143-2c4a1334cb04
Repository: https://github.com/retr0h/osapi.git
Documentation: pkg.go.dev

# Functions

Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewDeleteTaskIDRequest generates requests for DeleteTaskID.
NewGetNetworkDNSByInterfaceRequest generates requests for GetNetworkDNSByInterface.
NewGetSystemHostnameRequest generates requests for GetSystemHostname.
NewGetSystemStatusRequest generates requests for GetSystemStatus.
NewGetTaskIDRequest generates requests for GetTaskID.
NewGetTaskRequest generates requests for GetTask.
NewGetTaskStatusRequest generates requests for GetTaskStatus.
NewGetVersionRequest generates requests for GetVersion.
NewPostNetworkPingRequest calls the generic PostNetworkPing builder with application/json body.
NewPostNetworkPingRequestWithBody generates requests for PostNetworkPing with any type of body.
NewPostTaskRequest calls the generic PostTask builder with application/json body.
NewPostTaskRequestWithBody generates requests for PostTask with any type of body.
NewPutNetworkDNSRequest calls the generic PutNetworkDNS builder with application/json body.
NewPutNetworkDNSRequestWithBody generates requests for PutNetworkDNS with any type of body.
ParseDeleteTaskIDResponse parses an HTTP response from a DeleteTaskIDWithResponse call.
ParseGetNetworkDNSByInterfaceResponse parses an HTTP response from a GetNetworkDNSByInterfaceWithResponse call.
ParseGetSystemHostnameResponse parses an HTTP response from a GetSystemHostnameWithResponse call.
ParseGetSystemStatusResponse parses an HTTP response from a GetSystemStatusWithResponse call.
ParseGetTaskIDResponse parses an HTTP response from a GetTaskIDWithResponse call.
ParseGetTaskResponse parses an HTTP response from a GetTaskWithResponse call.
ParseGetTaskStatusResponse parses an HTTP response from a GetTaskStatusWithResponse call.
ParseGetVersionResponse parses an HTTP response from a GetVersionWithResponse call.
ParsePostNetworkPingResponse parses an HTTP response from a PostNetworkPingWithResponse call.
ParsePostTaskResponse parses an HTTP response from a PostTaskWithResponse call.
ParsePutNetworkDNSResponse parses an HTTP response from a PutNetworkDNSWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

No description provided by the author

# Structs

Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
No description provided by the author
DiskResponse Local disk usage information.
DNSConfigResponse defines model for DNSConfigResponse.
DNSConfigUpdateRequest defines model for DNSConfigUpdateRequest.
ErrorResponse defines model for ErrorResponse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HostnameResponse The hostname of the system.
LoadAverageResponse The system load averages for 1, 5, and 15 minutes.
MemoryResponse Memory usage information.
NetworkErrorResponse defines model for network.ErrorResponse.
OSInfoResponse Operating system information.
PingResponse defines model for PingResponse.
PostNetworkPingJSONBody defines parameters for PostNetworkPing.
No description provided by the author
PostTaskJSONBody defines parameters for PostTask.
No description provided by the author
No description provided by the author
SystemStatusResponse defines model for SystemStatusResponse.
TaskErrorResponse defines model for task.ErrorResponse.
TaskItemIdResponse defines model for TaskItemIdResponse.
TaskItemResponse defines model for TaskItemResponse.
TaskResponse defines model for TaskResponse.
TaskStatusResponse defines model for TaskStatusResponse.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

ClientOption allows setting custom parameters during construction.
DisksResponse List of local disk usage information.
PostNetworkPingJSONRequestBody defines body for PostNetworkPing for application/json ContentType.
PostTaskJSONRequestBody defines body for PostTask for application/json ContentType.
PutNetworkDNSJSONRequestBody defines body for PutNetworkDNS for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.