rest

type ArrayParameter interface {
	Parameter
	ElementType() Parameter
}

type BoolParameter interface {
	Parameter
	DefaultValue() bool
}

type Endpoint interface {
	ModelElement
	PathParameters() ParameterList //path parameters
	GetMethodDescriptor(method string) HttpMethodDescriptor
}

type FastCGI struct {
	Model Model
}

type FileParameter interface {
	Parameter
	//Indicates that file should be saved into temporary file. Otherwise, it will be recorded into memory
	Persistent() bool
}

type HttpMethodDescriptor interface {
	ModelElement
	Executor() cmdexec.CommandExecutor
	QueryParameters() ParameterList
	RequestHeaders() ParameterList
	Request() ParameterList               //definition of body bounded to MIME types
	Response() map[int]ResponseDescriptor //mapping between exit code of process and response
}

type IntegerParameter interface {
	Parameter
	DefaultValue() int64 //default value of parameter
}

type Model interface {
	Endpoints() map[string]Endpoint //set of endpoints declared in the model
	Name() string                   //name of model
}

type ModelElement interface {
	//Indicates that custom option is defined for model element
	HasOption(directive string) bool
}

type NumberParameter interface {
	Parameter
	DefaultValue() float64
}

type ObjectParameter interface {
	Parameter
	Fields() ParameterList
}

type Parameter interface {
	ModelElement
	Required() bool                  //parameter is required to be presented
	HasDefaultValue() bool           //parameter has default value
	Validate(value interface{}) bool //validate value of parameter
	ReadValue(value io.Reader, format ParameterValueFormat) (interface{}, error)
}

type ParameterList map[string]Parameter

type ParameterValueFormat int8

type ResponseDescriptor struct {
	Body       Parameter //response parameter description
	StatusCode int       //HTTP status code
	MimeType   string    //MIME type
}

type StandaloneServer struct {
	http.Server
	CertFile, KeyFile string
	Model             Model
}

type StringParameter interface {
	Parameter
	DefaultValue() string
}

type UnsupportedParameterValueFormat struct {
}