schemaserv

Documentation

Index

• Constants
• func HandleGetSchemaListRequest(c *gin.Context, s *service.Service)
• func HandleGetSchemaRequest(c *gin.Context, s *service.Service)
• type GetSchemaListResponse
• type GetSchemaRequest
• type GetSchemaResponse

Constants

const (

	//error messages
	SCHEMA_NOT_FOUND = "schema_not_found"

	// validation errors
	APP_NAME_REQUIRED      = "App Name required"
	MODULE_NAME_REQUIRED   = "Module Name required"
	VERSION_NAME_REQUIRED  = "Version is required"
	INVALID_VERSION        = "invalid version"
	DESCRIPTION_TIMED_OUT  = "description get timed out"
	DESCRIPTION_GET_FAILED = "description get failed"
)

Functions

func HandleGetSchemaListRequest

func HandleGetSchemaListRequest(c *gin.Context, s *service.Service)

func HandleGetSchemaRequest

func HandleGetSchemaRequest(c *gin.Context, s *service.Service)

HandleGetSchemaRequest gets a schema details based on given schemaName , schemaModule and schemaVersion

Types

type GetSchemaListResponse

type GetSchemaListResponse struct {
	App         string `json:"app"`
	Module      string `json:"module"`
	Ver         int    `json:"ver"`
	Description string `json:"description"`
}

getSchemaResponse represents the structure for outgoing responses.

type GetSchemaRequest

type GetSchemaRequest struct {
	App     string `form:"app" validate:"required"`
	Module  string `form:"module" validate:"required"`
	Version int    `form:"ver"  validate:"required"`
}

GetSchemaRequest represents the structure for incoming requests.

type GetSchemaResponse

type GetSchemaResponse struct {
	App         string        `json:"app"`
	Module      string        `json:"module"`
	Ver         int           `json:"ver"`
	Fields      []types.Field `json:"fields"`
	Description string        `json:"description"`
}

getSchemaResponse represents the structure for outgoing responses.