service

type Endpoint struct {
	Route   string    // the absolute URL path for this endpoint
	Head    *Pipeline // HEAD method pipeline
	Get     *Pipeline // GET method pipeline
	Put     *Pipeline // PUT method pipeline
	Post    *Pipeline // POST method pipeline
	Patch   *Pipeline // PATCH method pipeline
	Delete  *Pipeline // DELETE method pipeline
	Connect *Pipeline // CONNECT method pipeline
	Options *Pipeline // OPTIONS method pipeline
	Trace   *Pipeline // TRACE method pipeline
}

type Pipeline struct {
	Policy       Policy                  // customizes automated behavior
	Handlers     []httpx.Handler         // the pipline steps, minimum one
	QuerySchemas []httpx.ParameterSchema // optional query parameter validation
}

type Policy struct {
	// Will malformed query parameters be passed through or
	// rejected?
	AllowMalformedQueryParameters bool `json:",omitempty"`
	// Will unknown query parameters be passed through or
	// rejected?
	AllowUnknownQueryParameters bool `json:",omitempty"`
	// Will requests  with missing/extra trailing slash
	// be redirected?
	AllowTrailingSlashRedirects bool `json:",omitempty"`
	// Will URL escaped path parameters be preserved?
	PreserveEscapedPathParameters bool `json:",omitempty"`
	// The time budget for the pipeline to complete
	TimeBudget time.Duration `json:",omitempty"`
}

type Service struct {
	Name      string     // Service name.  Required.
	Endpoints []Endpoint // Service endpoints. Requried.

	// Handlers are optional handlers that should be invoked for
	// all endpoints.  These will be prepended to all endpoint
	// handlers when a service is registered.
	Handlers []httpx.Handler

	// MalformedRequestHandler optionally customizes the
	// response to the user agent when a malformed request is
	// presented.
	// If nil the default handler wil return a 400 status code
	// with an empty body.
	MalformedRequestHandler httpx.Handler

	// MethodNotAllowedHandler optionally customizes the response
	// returned to the user agent when an endpoint isn't
	// configured to service the method of a request.
	// If nil the default handler will return a 405 status code
	// with an empty body.
	MethodNotAllowedHandler httpx.Handler

	// RedirectHandler optionally customizes the response
	// returned to the user agent when an endpoint is configured
	// to return a redirect for a path based on a missing or
	// extra trailing slash.
	// If nil the default handler will return a 303 status code
	// for GET and a 307 for other methods, both with an empty
	// body.
	RedirectHandler httpx.Handler

	// InternalServerErrorHandler optionally customizes the
	// response returned to the user agent when the gateway
	// encounters an error trying to service a request to an
	// endoint of this service.
	// If nil the default handler will return a 500 status code
	// with an empty body.
	InternalServerErrorHandler httpx.ErrorHandler
}