handlers

package

v0.3.0 Latest Latest Go to latest Published: Oct 10, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/matthisholleville/mapsyncproxy

Links

Open Source Insights

Documentation ¶

Overview ¶

Package handlers for monitoring api call.

Index ¶

func Health(echo echo.Context) error
func Ready(echo echo.Context) error
func Synchronize(c echo.Context) (err error)
type Response
type SynchronizeRequestBody

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Health ¶

func Health(echo echo.Context) error

Health godoc

@Tags			Monitoring
@Summary		Health.
@Description	Health.
@Accept			*/*
@Produce		json
@Success		200
@Router			/healthz [get]

func Ready ¶

func Ready(echo echo.Context) error

Ready godoc

@Tags			Monitoring
@Summary		Ready.
@Description	Ready.
@Accept			*/*
@Produce		json
@Success		200
@Router			/readyz [get]

func Synchronize ¶

func Synchronize(c echo.Context) (err error)

Synchronize godoc

@Tags			Synchronization
@Summary		Synchronize GCS file to an HAProxy map file.
@Description	Synchronize GCS file to an HAProxy map file.
@Accept			json
@Produce		json
@Param		_			body	SynchronizeRequestBody	true	"Data of the synchronisation endpoint"

@Success 200 @Failure 500 "Internal Server Error" @Router /v1/synchronize [post]

Types ¶

type Response ¶

type Response struct {
	Message string `json:"message"`
}

type SynchronizeRequestBody ¶

type SynchronizeRequestBody struct {
	MapName        string `json:"map_name"  validate:"required,map_name"`
	BucketName     string `json:"bucket_name" validate:"required,bucket_name"`
	BucketFileName string `json:"bucket_file_name" validate:"required,bucket_file_name"`
}

Source Files ¶

View all Source files

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