package
0.0.0-20240623054541-ac821485d958
Repository: https://github.com/andkrause/vpnc-web-ui.git
Documentation: pkg.go.dev
# Functions
AssertConnectionStatusConstraints checks if the values respects the defined constraints.
AssertConnectionStatusRequired checks if the required fields are not zero-ed.
AssertDesiredConnectionStatusConstraints checks if the values respects the defined constraints.
AssertDesiredConnectionStatusRequired checks if the required fields are not zero-ed.
AssertErrorConstraints checks if the values respects the defined constraints.
AssertErrorRequired checks if the required fields are not zero-ed.
AssertRecurseInterfaceRequired recursively checks each struct in a slice against the callback.
AssertRecurseValueRequired checks each struct in the nested slice against the callback.
AssertStatusConstraints checks if the values respects the defined constraints.
AssertStatusRequired checks if the required fields are not zero-ed.
AssertVpnConfigConstraints checks if the values respects the defined constraints.
AssertVpnConfigRequired checks if the required fields are not zero-ed.
DefaultErrorHandler defines the default logic on how to handle errors from the controller.
EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code.
IsZeroValue checks if the val is the zero-ed value.
No description provided by the author
NewRouter creates a new router for any number of api routers.
NewVpnConnectionAPIController creates a default api controller.
NewVpnGatewayAPIController creates a default api controller.
ReadFormFilesToTempFiles reads files array data from a request form and writes it to a temporary files.
ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file.
Response return a ImplResponse struct filled.
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
WithVpnConnectionAPIErrorHandler inject ErrorHandler into controller.
WithVpnGatewayAPIErrorHandler inject ErrorHandler into controller.
# Variables
ErrTypeAssertionError is thrown when type an interface does not match the asserted type.
# Structs
No description provided by the author
No description provided by the author
Error - Generic Error.
ImplResponse defines an implementation response with error code and the associated body.
ParsingError indicates that an error has occurred when parsing request parameters.
RequiredError indicates that an error has occurred when parsing request parameters.
A Route defines the parameters for an api endpoint.
No description provided by the author
No description provided by the author
VpnConnectionAPIController binds http requests to an api service and writes the service results to the http response.
VpnGatewayAPIController binds http requests to an api service and writes the service results to the http response.
# Interfaces
No description provided by the author
Router defines the required methods for retrieving api routes.
VpnConnectionAPIRouter defines the required methods for binding the api requests to a responses for the VpnConnectionAPI The VpnConnectionAPIRouter implementation should parse necessary information from the http request, pass the data to a VpnConnectionAPIServicer to perform the required actions, then write the service results to the http response.
VpnConnectionAPIServicer defines the api actions for the VpnConnectionAPI service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
VpnGatewayAPIRouter defines the required methods for binding the api requests to a responses for the VpnGatewayAPI The VpnGatewayAPIRouter implementation should parse necessary information from the http request, pass the data to a VpnGatewayAPIServicer to perform the required actions, then write the service results to the http response.
VpnGatewayAPIServicer defines the api actions for the VpnGatewayAPI service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
# Type aliases
No description provided by the author
ErrorHandler defines the required method for handling error.
No description provided by the author
No description provided by the author
Routes is a map of defined api endpoints.
VpnConnectionAPIOption for how the controller is set up.
VpnGatewayAPIOption for how the controller is set up.