handlers

package
v0.0.5 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckBlueprintOfGcpAwsVpn added in v0.0.5 

func CheckBlueprintOfGcpAwsVpn(c echo.Context) error

CheckBlueprintOfGcpAwsVpn godoc @Summary Show changes required by the current blueprint to configure GCP to AWS VPN tunnels @Description Show changes required by the current blueprint to configure GCP to AWS VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/plan [post]

func CheckBlueprintOfGcpAzureVpn added in v0.0.5 

func CheckBlueprintOfGcpAzureVpn(c echo.Context) error

CheckBlueprintOfGcpAzureVpn godoc @Summary Show changes required by the current blueprint to configure GCP to Azure VPN tunnels @Description Show changes required by the current blueprint to configure GCP to Azure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/plan [post]

func CheckBlueprintOfTestEnv added in v0.0.5 

func CheckBlueprintOfTestEnv(c echo.Context) error

CheckBlueprintOfTestEnv godoc @Summary Show changes required by the current blueprint to configure test environment @Description Show changes required by the current blueprint to configure test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/plan [post]

func ClearGcpAwsVpn added in v0.0.2 

func ClearGcpAwsVpn(c echo.Context) error

ClearGcpAwsVpn godoc @Summary Clear the entire directory and configuration files @Description Clear the entire directory and configuration files @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/clear [delete]

func ClearGcpAzureVpn added in v0.0.2 

func ClearGcpAzureVpn(c echo.Context) error

ClearGcpAzureVpn godoc @Summary Clear the entire directory and configuration files @Description Clear the entire directory and configuration files @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/clear [delete]

func ClearResourceGroup added in v0.0.2 

func ClearResourceGroup(c echo.Context) error

ClearResourceGroup godoc @Summary Clear the entire directories and configuration files @Description Clear the entire directories and configuration files @Tags [ResourceGroup] Resource group @Accept json @Produce json @Param ResourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId} [delete]

func ClearTestEnv added in v0.0.2 

func ClearTestEnv(c echo.Context) error

ClearTestEnv godoc @Summary Clear the entire directory and configuration files @Description Clear the entire directory and configuration files @Tags [Test env] Test environment management @Accept json @Produce json @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/clear [delete]

func CreateBlueprintOfGcpAwsVpn added in v0.0.5 

func CreateBlueprintOfGcpAwsVpn(c echo.Context) error

CreateBlueprintOfGcpAwsVpn godoc @Summary Create a blueprint to configure GCP to AWS VPN tunnels @Description Create a blueprint to configure GCP to AWS VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Param ParamsForBlueprint body CreateBluprintOfGcpAwsVpnRequest true "Parameters requied to create a blueprint to configure GCP to AWS VPN tunnels" @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/blueprint [post]

func CreateBlueprintOfGcpAzureVpn added in v0.0.5 

func CreateBlueprintOfGcpAzureVpn(c echo.Context) error

CreateBlueprintOfGcpAzureVpn godoc @Summary Create a blueprint to configure GCP to Azure VPN tunnels @Description Create a blueprint to configure GCP to Azure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Param ParamsForBlueprint body CreateBluprintOfGcpAzureVpnRequest true "Parameters requied to create a blueprint to configure GCP to Azure VPN tunnels" @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/blueprint [post]

func CreateBlueprintOfTestEnv added in v0.0.5 

func CreateBlueprintOfTestEnv(c echo.Context) error

CreateBluprintOfGcpAzureVpn godoc @Summary Create a blueprint to configure test environment @Description Create a blueprint to configure test environment @Tags [Test env] Test environment management @Accept json @Produce json @Param ParamsForBlueprint body CreateBluprintOfTestEnvRequest true "Parameters requied to create a blueprint to configure test environment" @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/blueprint [post]

func CreateGcpAwsVpn added in v0.0.2 

func CreateGcpAwsVpn(c echo.Context) error

CreateGcpAwsVpn godoc @Summary Create network resources for VPN tunnel in GCP and AWS @Description Create network resources for VPN tunnel in GCP and AWS @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws [post]

func CreateGcpAzureVpn added in v0.0.2 

func CreateGcpAzureVpn(c echo.Context) error

CreateGcpAzureVpn godoc @Summary Create network resources for VPN tunnel in GCP and Azure @Description Create network resources for VPN tunnel in GCP and Azure @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure [post]

func CreateTestEnv added in v0.0.2 

func CreateTestEnv(c echo.Context) error

CreateTestEnv godoc @Summary Create test environment @Description Create test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env [post]

func CreateUser 

func CreateUser(c echo.Context) error

CreateUser godoc @Summary Create a new user @Description Create a new user with the given information. @Tags [Sample] Users @Accept json @Produce json @Param User body CreateUserRequest true "User information" @Success 201 {object} GetUserResponse "(Sample) This is a sample description for success response in Swagger UI" @Failure 400 {object} object "Invalid Request" @Router /sample/users [post]

func DeleteUser 

func DeleteUser(c echo.Context) error

DeleteUser godoc @Summary Delete a user @Description Delete a user with the given information. @Tags [Sample] Users @Accept json @Produce json @Param id path int true "User ID" @Success 200 {string} string "User deletion successful" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "User Not Found" @Router /sample/users/{id} [delete]

func DestroyGcpAwsVpn added in v0.0.2 

func DestroyGcpAwsVpn(c echo.Context) error

DestroyGcpAwsVpn godoc @Summary Destroy network resources that were used to configure GCP as an AWS VPN tunnel @Description Destroy network resources that were used to configure GCP as an AWS VPN tunnel @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws [delete]

func DestroyGcpAzureVpn added in v0.0.2 

func DestroyGcpAzureVpn(c echo.Context) error

DestroyGcpAzureVpn godoc @Summary Destroy network resources that were used to configure GCP as an Azure VPN tunnel @Description Destroy network resources that were used to configure GCP as an Azure VPN tunnel @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure [delete]

func DestroyTestEnv added in v0.0.2 

func DestroyTestEnv(c echo.Context) error

DestroyTestEnv godoc @Summary Destroy test environment @Description Destroy test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env [delete]

func GetAllResouceIdOfTestEnv added in v0.0.5 

func GetAllResouceIdOfTestEnv(c echo.Context) error

GetAllResouceIdOfTestEnv godoc @Summary Get all resource IDs of test environment @Description Get all resource IDs of test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 200 {object} models.ResponseObject "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/resource/id [get]

func GetAllResouceInfoOfTestEnv added in v0.0.5 

func GetAllResouceInfoOfTestEnv(c echo.Context) error

GetAllResouceInfoOfTestEnv godoc @Summary Get all resource info of test environment @Description Get all resource info of test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 200 {object} models.ResponseList "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/resource/info [get]

func GetAllResourceIdOfGcpAwsVpn added in v0.0.5 

func GetAllResourceIdOfGcpAwsVpn(c echo.Context) error

GetAllResourceIdOfGcpAwsVpn godoc @Summary Get all resource IDs to configure GCP to AWS VPN tunnels @Description Get all resource IDs to configure GCP to AWS VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseObject "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/resource/id [get]

func GetAllResourceIdOfGcpAzureVpn added in v0.0.5 

func GetAllResourceIdOfGcpAzureVpn(c echo.Context) error

GetAllResourceIdOfGcpAzureVpn godoc @Summary Get all resource IDs to configure GCP to Azure VPN tunnels @Description Get all resource IDs to configure GCP to Azure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseObject "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/resource/id [get]

func GetAllResourceInfoOfGcpAwsVpn added in v0.0.5 

func GetAllResourceInfoOfGcpAwsVpn(c echo.Context) error

GetAllResourceInfoOfGcpAwsVpn godoc @Summary Get all resource info to configure GCP to AWS VPN tunnels @Description Get all resource info to configure GCP to AWS VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseList "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/resource/info [get]

func GetAllResourceInfoOfGcpAzureVpn added in v0.0.5 

func GetAllResourceInfoOfGcpAzureVpn(c echo.Context) error

GetAllResourceInfoOfGcpAzureVpn godoc @Summary Get all resource info to configure GCP to Azure VPN tunnels @Description Get all resource info to configure GCP to Azure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 200 {object} models.ResponseList "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/resource/info [get]

func GetRequestStatusOfGcpAwsVpn added in v0.0.2 

func GetRequestStatusOfGcpAwsVpn(c echo.Context) error

GetRequestStatusOfGcpAwsVpn godoc @Summary Get the status of the request to configure GCP to AWS VPN tunnels @Description Get the status of the request to configure GCP to AWS VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Param requestId path string true "Request ID" @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/request/{requestId}/status [get]

func GetRequestStatusOfGcpAzureVpn added in v0.0.2 

func GetRequestStatusOfGcpAzureVpn(c echo.Context) error

GetRequestStatusOfGcpAzureVpn godoc @Summary Get the status of the request to configure GCP to Azure VPN tunnels @Description Get the status of the request to configure GCP to Azure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Param requestId path string true "Request ID" @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/request/{requestId}/status [get]

func GetRequestStatusOfTestEnv added in v0.0.2 

func GetRequestStatusOfTestEnv(c echo.Context) error

GetRequestStatusOfTestEnv godoc @Summary Get the status of the request to configure test environment @Description Get the status of the request to configure test environment @Tags [Test env] Test environment management @Accept json @Produce json @Param requestId path string true "Request ID" @Success 200 {object} models.ResponseText "OK" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/request/{requestId}/status [get]

func GetUser 

func GetUser(c echo.Context) error

GetUser godoc @Summary Get specific user information @Description Get information of a user with a specific ID. @Tags [Sample] Users @Accept json @Produce json @Param id path int true "User ID" @Success 200 {object} GetUserResponse "(Sample) This is a sample description for success response in Swagger UI" @Failure 404 {object} object "User Not Found" @Router /sample/users/{id} [get]

func GetUsers 

func GetUsers(c echo.Context) error

GetUsers godoc @Summary Get a list of users @Description Get information of all users. @Tags [Sample] Users @Accept json @Produce json @Success 200 {object} GetUsersResponse "(sample) This is a sample description for success response in Swagger UI" @Failure 404 {object} object "User Not Found" @Router /sample/users [get]

func HTTPVersion 

func HTTPVersion(c echo.Context) error

HTTPVersion godoc @Summary Check HTTP version of incoming request @Description Checks and logs the HTTP version of the incoming request to the server console. @Tags [System] Utility @Accept json @Produce json @Success 200 {object} models.ResponseText @Failure 404 {object} models.ResponseText @Failure 500 {object} models.ResponseText @Router /httpVersion [get]

func Health 

func Health(c echo.Context) error

Health godoc @Summary Check API server is running @Description Check API server is running @Tags [System] Utility @Accept json @Produce json @Success 200 {object} models.ResponseText @Failure 503 {object} models.ResponseText @Router /health [get]

func InitGcpAndAwsForVpn added in v0.0.2 

func InitGcpAndAwsForVpn(c echo.Context) error

InitGcpAndAwsForVpn godoc @Summary Initialize GCP and AWS to configure VPN tunnels @Description Initialize GCP and AWS to configure VPN tunnels @Tags [VPN] GCP to AWS VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-aws/init [post]

func InitGcpAndAzureForVpn added in v0.0.2 

func InitGcpAndAzureForVpn(c echo.Context) error

InitGcpAndAzureForVpn godoc @Summary Initialize GCP and Azure to configure VPN tunnels @Description Initialize GCP and Azure to configure VPN tunnels @Tags [VPN] GCP to Azure VPN tunnel configuration @Accept json @Produce json @Param resourceGroupId path string true "Resource group ID" default(tofu-rg-01) @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /rg/{resourceGroupId}/vpn/gcp-azure/init [post]

func InitTestEnv added in v0.0.2 

func InitTestEnv(c echo.Context) error

InitTestEnv godoc @Summary Initialize test environment @Description Initialize test environment @Tags [Test env] Test environment management @Accept json @Produce json @Success 201 {object} models.ResponseText "Created" @Failure 400 {object} models.ResponseText "Bad Request" @Failure 503 {object} models.ResponseText "Service Unavailable" @Router /test-env/init [post]

func PatchUser 

func PatchUser(c echo.Context) error

PatchUser godoc @Summary Patch a user @Description Patch a user with the given information. @Tags [Sample] Users @Accept json @Produce json @Param id path int true "User ID" @Param User body PatchUserRequest true "User information to update" @Success 200 {object} PatchUserResponse "(Sample) This is a sample description for success response in Swagger UI" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "User Not Found" @Router /sample/users/{id} [patch]

func TofuVersion 

func TofuVersion(c echo.Context) error

TofuVersion godoc @Summary Check Tofu version @Description Check Tofu version @Tags [System] Utility @Accept json @Produce json @Success 200 {object} models.ResponseText @Failure 503 {object} models.ResponseText @Router /tofuVersion [get]

func UpdateUser 

func UpdateUser(c echo.Context) error

UpdateUser godoc @Summary Update a user @Description Update a user with the given information. @Tags [Sample] Users @Accept json @Produce json @Param id path int true "User ID" @Param User body UpdateUserRequest true "User information to update" @Success 201 {object} UpdateUserResponse "(Sample) This is a sample description for success response in Swagger UI" @Failure 400 {object} object "Invalid Request" @Router /sample/users/{id} [put]

Types

type CreateBluprintOfGcpAwsVpnRequest added in v0.0.2 

type CreateBluprintOfGcpAwsVpnRequest struct {
	TfVars models.TfVarsGcpAwsVpnTunnel `json:"tfVars"`
}

type CreateBluprintOfGcpAzureVpnRequest added in v0.0.2 

type CreateBluprintOfGcpAzureVpnRequest struct {
	TfVars models.TfVarsGcpAzureVpnTunnel `json:"tfVars"`
}

type CreateBluprintOfTestEnvRequest added in v0.0.2 

type CreateBluprintOfTestEnvRequest struct {
	TfVars models.TfVarsTestEnv `json:"tfVars"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type CreateUserResponse 

type CreateUserResponse struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type GetUserResponse 

type GetUserResponse struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type GetUsersResponse 

type GetUsersResponse struct {
	Users []models.MyUser `json:"users"`
}

type InitGcpAndAwsForVpnTunnelRequest added in v0.0.2 

type InitGcpAndAwsForVpnTunnelRequest struct {
	ResourceGroupId string `json:"resourceGroupId" default:"tofu-rg-01"`
}

//////////////////////////////////////////////////// GCP and AWS

type PatchUserRequest 

type PatchUserRequest struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type PatchUserResponse 

type PatchUserResponse struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type UpdateUserRequest 

type UpdateUserRequest struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

type UpdateUserResponse 

type UpdateUserResponse struct {
	models.MyUser
}

[Note] Struct Embedding is used to inherit the fields of MyUser

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.