rest

type ErrorResponse struct {
	// Description Human-readable description of the error
	Description *string `json:"description,omitempty"`

	// Error Error code, only somewhat human-readable
	Error ErrorResponseError `json:"error"`
}

type ErrorResponseError string

type Flags struct {
	Address string `help:"The address to bind the REST API server to." default:":8080"`
}

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

type LoginJSONBody struct {
	// Password The password of the account.
	Password string `json:"password"`

	// Username The username of the account.
	Username string `json:"username"`
}

type LoginJSONRequestBody LoginJSONBody

type LogoutParams struct {
	// Session The session token to invalidate.
	Session string `form:"session" json:"session"`
}

type MiddlewareFunc func(c *gin.Context)

type ParseReportTextBody = string

type ParseReportTextRequestBody = ParseReportTextBody

type ServerInterface interface {
	// OpenAPI specification (JSON)
	// (GET /api/openapi.json)
	OpenapiJson(c *gin.Context)
	// OpenAPI specification (YAML)
	// (GET /api/openapi.yaml)
	OpenapiYaml(c *gin.Context)
	// Redoc documentation
	// (GET /api/redoc)
	Redoc(c *gin.Context)
	// Scalar documentation
	// (GET /api/scalar)
	Scalar(c *gin.Context)
	// Parse a code coverage report
	// (POST /api/v0/parse-report)
	ParseReport(c *gin.Context)
	// Login to an account
	// (POST /api/v1/login)
	Login(c *gin.Context)
	// Log out of an account
	// (GET /api/v1/logout)
	Logout(c *gin.Context, params LogoutParams)
	// Ping the server
	// (GET /api/v1/ping)
	Ping(c *gin.Context)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}