openapi

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Coordinate = float64

type GetNeuronCompartmentsMembranePotentialResponse struct {
	MembranePotentials []float64 `json:"membranePotentials"`

	// TimeStep Step Time of the membrane potential.
	TimeStep float64 `json:"timeStep"`
}

type GetNeuronCompartmentsResponse struct {
	Compartments []NeuronCompartment `json:"compartments"`
}

type GetNeuronsResponse struct {
	Neurons []Neuron `json:"neurons"`
}

type HealthCheckResponse struct {
	// Message Message of the health check
	Message string `json:"message"`

	// Status Status of the health check
	Status HealthCheckResponseStatus `json:"status"`
}

type HealthCheckResponseStatus string

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type MiddlewareFunc func(http.Handler) http.Handler

type Neuron struct {
	// Name Name of the neuron
	Name NeuronName `json:"name"`
}

type NeuronCompartment struct {
	// Id ID of the compartment, unique for the same neuron.
	Id int64 `json:"id"`

	// ParentId ID of the parent compartment. -1 indicates no parent compartment.
	ParentId int64 `json:"parentId"`

	// PositionX Coordinate for example x, y, z
	PositionX Coordinate `json:"positionX"`

	// PositionY Coordinate for example x, y, z
	PositionY Coordinate `json:"positionY"`

	// PositionZ Coordinate for example x, y, z
	PositionZ Coordinate `json:"positionZ"`

	// Radius Radius of the compartment.
	Radius float64               `json:"radius"`
	Type   NeuronCompartmentType `json:"type"`
}

type NeuronCompartmentType struct {
	// Id ID of the compartment type.
	Id int64 `json:"id"`

	// Name Type of the compartment.
	//   SOMA (細胞体).
	//   AXON (軸索).
	//   BASAL_DENDRITE (基底樹状突起).
	//   APICAL_DENDRITE (尖端樹状突起).
	Name NeuronCompartmentTypeName `json:"name"`
}

type NeuronCompartmentTypeName string

type NeuronName = string

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type ServerInterface interface {
	// Health check
	// (GET /api/v1/health)
	HealthCheck(w http.ResponseWriter, r *http.Request)
	// Get neurons available for visualization
	// (GET /api/v1/neurons)
	GetNeurons(w http.ResponseWriter, r *http.Request)
	// Get compartments of the neuron
	// (GET /api/v1/neurons/{neuron_name}/compartments)
	GetNeuronCompartments(w http.ResponseWriter, r *http.Request, neuronName NeuronName)
	// Get membrane potentials of the neuron
	// (GET /api/v1/neurons/{neuron_name}/compartments/membranePotentials)
	GetNeuronMembranePotentials(w http.ResponseWriter, r *http.Request, neuronName NeuronName)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type Unimplemented struct{}

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}