openapi

package
v0.0.0-...-62d42d8 Latest Latest
Warning

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

 Go to latest Published: Jan 20, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package openapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.0 DO NOT EDIT.

Package openapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Handler 

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux 

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL 

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions 

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

Types

type ChiServerOptions 

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

type Coordinate 

type Coordinate = float64

Coordinate Coordinate for example x, y, z

type GetNeuronCompartmentsMembranePotentialResponse 

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

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

GetNeuronCompartmentsMembranePotentialResponse defines model for GetNeuronCompartmentsMembranePotentialResponse.

type GetNeuronCompartmentsResponse 

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

GetNeuronCompartmentsResponse defines model for GetNeuronCompartmentsResponse.

type GetNeuronsResponse 

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

GetNeuronsResponse defines model for GetNeuronsResponse.

type HealthCheckResponse 

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

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

HealthCheckResponse defines model for HealthCheckResponse.

type HealthCheckResponseStatus 

type HealthCheckResponseStatus string

HealthCheckResponseStatus Status of the health check 

const (
	ERROR HealthCheckResponseStatus = "ERROR"
	OK    HealthCheckResponseStatus = "OK"
)

Defines values for HealthCheckResponseStatus.

type InvalidParamFormatError 

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error 

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap 

func (e *InvalidParamFormatError) Unwrap() error

type MiddlewareFunc 

type MiddlewareFunc func(http.Handler) http.Handler

type Neuron 

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

Neuron defines model for Neuron.

type NeuronCompartment 

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"`
}

NeuronCompartment defines model for NeuronCompartment.

type NeuronCompartmentType 

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"`
}

NeuronCompartmentType defines model for NeuronCompartmentType.

type NeuronCompartmentTypeName 

type NeuronCompartmentTypeName string

NeuronCompartmentTypeName Type of the compartment. 

SOMA (細胞体).
AXON (軸索).
BASAL_DENDRITE (基底樹状突起).
APICAL_DENDRITE (尖端樹状突起).

const (
	APICALDENDRITE NeuronCompartmentTypeName = "APICAL_DENDRITE"
	AXON           NeuronCompartmentTypeName = "AXON"
	BASALDENDRITE  NeuronCompartmentTypeName = "BASAL_DENDRITE"
	SOMA           NeuronCompartmentTypeName = "SOMA"
)

Defines values for NeuronCompartmentTypeName.

type NeuronName 

type NeuronName = string

NeuronName Name of the neuron

type RequiredHeaderError 

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error 

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap 

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError 

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error 

func (e *RequiredParamError) Error() string

type ServerInterface 

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)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

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

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) GetNeuronCompartments 

func (siw *ServerInterfaceWrapper) GetNeuronCompartments(w http.ResponseWriter, r *http.Request)

GetNeuronCompartments operation middleware

func (*ServerInterfaceWrapper) GetNeuronMembranePotentials 

func (siw *ServerInterfaceWrapper) GetNeuronMembranePotentials(w http.ResponseWriter, r *http.Request)

GetNeuronMembranePotentials operation middleware

func (*ServerInterfaceWrapper) GetNeurons 

func (siw *ServerInterfaceWrapper) GetNeurons(w http.ResponseWriter, r *http.Request)

GetNeurons operation middleware

func (*ServerInterfaceWrapper) HealthCheck 

func (siw *ServerInterfaceWrapper) HealthCheck(w http.ResponseWriter, r *http.Request)

HealthCheck operation middleware

type TooManyValuesForParamError 

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error 

func (e *TooManyValuesForParamError) Error() string

type UnescapedCookieParamError 

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error 

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap 

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented 

type Unimplemented struct{}

func (Unimplemented) GetNeuronCompartments 

func (_ Unimplemented) GetNeuronCompartments(w http.ResponseWriter, r *http.Request, neuronName NeuronName)

Get compartments of the neuron (GET /api/v1/neurons/{neuron_name}/compartments)

func (Unimplemented) GetNeuronMembranePotentials 

func (_ Unimplemented) GetNeuronMembranePotentials(w http.ResponseWriter, r *http.Request, neuronName NeuronName)

Get membrane potentials of the neuron (GET /api/v1/neurons/{neuron_name}/compartments/membranePotentials)

func (Unimplemented) GetNeurons 

func (_ Unimplemented) GetNeurons(w http.ResponseWriter, r *http.Request)

Get neurons available for visualization (GET /api/v1/neurons)

func (Unimplemented) HealthCheck 

func (_ Unimplemented) HealthCheck(w http.ResponseWriter, r *http.Request)

Health check (GET /api/v1/health)

type UnmarshalingParamError 

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error 

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap 

func (e *UnmarshalingParamError) Unwrap() error

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.